Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove JsDocs Warnings #2039

Closed
jesdaigle opened this issue Sep 14, 2021 · 5 comments
Closed

Remove JsDocs Warnings #2039

jesdaigle opened this issue Sep 14, 2021 · 5 comments
Assignees
@howard-e
Labels
Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation

Comments

@jesdaigle
Copy link
Contributor

Per TF meeting, remove JsDoc warning.
@jesdaigle jesdaigle self-assigned this Sep 14, 2021
@mcking65
Copy link
Contributor

Per group discussion on today, run the autofix

@a11ydoer a11ydoer added the Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation label Apr 5, 2022
@richnoah richnoah assigned howard-e and unassigned jesdaigle Apr 12, 2022
@css-meeting-bot
Copy link
Member

The ARIA Authoring Practices (APG) Task Force just discussed Remove JsDocs Warnings #2039.

The full IRC log of that discussion <Jem> Topic:Remove JsDocs Warnings #2039
<jamesn> github: https://github.com//issues/2039
<siri_> Rich: Js.doc, is warning about blank *, white space, as discussion few days ago about auto fixes
<siri_> MK: They were showing up on the files tab, hope everyones comments are wrt JS.doc
<siri_> Howard has no questions

@howard-e
Copy link
Contributor

As stated discussion yesterday:

Rich: Js.doc, is warning about blank *, white space, as discussion few days ago about auto fixes
MK: They were showing up on the files tab, hope everyones comments are wrt JS.doc

@mcking65 not seeing those warnings currently or able to reproduce. Is there any example you could point me to for further help? Otherwise, maybe this has been resolved and we can close this issue

The only thing I can see is the following lint-html errors. But these warnings seem to all be acceptable based on the comments before these lines in the code:

  • The “banner” role is unnecessary for element “header”. [examples/treeview/treeview-navigation.html#L66]
  • Consider using the “h1” element as a top-level heading only (all “h1” elements are treated as top-level headings by many screen readers and other tools). [examples/treeview/treeview-navigation.html#L323]
  • The “contentinfo” role is unnecessary for element “footer”. [examples/treeview/treeview-navigation.html#L332]
  • The “banner” role is unnecessary for element “header”. [examples/menubar/menubar-navigation.html#L64]
  • Consider using the “h1” element as a top-level heading only (all “h1” elements are treated as top-level headings by many screen readers and other tools). [examples/menubar/menubar-navigation.html#L233]
  • The “contentinfo” role is unnecessary for element “footer”. [examples/menubar/menubar-navigation.html#L242]

@nschonni
Copy link
Contributor

Think it was already fixed in #2032

@mcking65
Copy link
Contributor

closed by #2032

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@howard-e howard-e

Labels
Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@nschonni @howard-e @mcking65 @a11ydoer @css-meeting-bot @jesdaigle