Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add guideline to usedescribe() #6387

Closed
@Qianqianye

Description

@Qianqianye

Topic

We are in the process of includingdescribe() in all reference code, as mentioned in the issue#5139: Use describe() to create accessible canvas descriptions in inline documentation.

I think creating a guideline to use describe() would be really helpful. This guideline will not only help contributors but also users (as mentioned in issue#5427) to write description.

@katlich112358 recently wrote a wonderful tutorial about 'How to label your p5.js code', which include some guideline like: "Within reason, less is more with screen reader labeling. Be concise, accurate, and short with your label descriptions." In the Pull Request#5599,@lm-n suggested that 'It'd be great if none of the descriptions are more than 3 lines long.'

We can create a more detailed guideline which includes recommended length of description, recommended and non-recommended examples of using describe(), etc. The 'Image Description Guide' created by@natdecker could be a great reference. The guideline could either be included in the 'How to label your p5.js code' tutorial ordocumentation_style_guide.md initiated by@nickmcintyre.

Would love to hear what you all think!

CC:@limzykenneth@davepagurek@katlich112358@calebfoss@paulaxisabel@nickmcintyre@cosmicbhejafry

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Completed

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp