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.

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

Document axe-core's required globals #1531

Closed
WilcoFiers opened this issue May 1, 2019 · 4 comments
Closed

Document axe-core's required globals #1531

WilcoFiers opened this issue May 1, 2019 · 4 comments
Assignees
Labels
core Issues in the core code (lib/core) docs Documentation changes

Comments

@WilcoFiers
Copy link
Contributor

WilcoFiers commented May 1, 2019

To run, axe-core requires a number of globals to be set up. This isn't properly described in the documentation, so we need to add this.

The required globals are tested in a jsdom example here:
https://github.com/dequelabs/axe-core/pull/1530/files#diff-bdce4c640c93affd7131cd773f65ba2fR35

@WilcoFiers WilcoFiers added docs Documentation changes core Issues in the core code (lib/core) labels May 1, 2019
@straker straker self-assigned this Jun 6, 2019
@jeankaplansky
Copy link
Contributor

@straker: The docs are present, but the markdown for the table of contents is missing entries (for more things than just the required globals). I don't want a TOC to hold up a release though so if it's something you're not comfortable updating for July 1, please make a new ticket "update TOC for axe-core/docs/api.md" as a docs ticket and put it in the sprint ready bucket. I'll grab it when I get back.

If @aellsey and @straker are cool with this, I'll move the ticket to the Ready for QA column. Please advise. Thanks!

@jeankaplansky
Copy link
Contributor

@straker - please see the last message above. Are we good to go with moving this to "Ready for QA"? Thanks!

@straker
Copy link
Contributor

straker commented Jul 8, 2019

Sorry, forgot about this. Created a pr for this #1682

@jeankaplansky
Copy link
Contributor

TOC fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Issues in the core code (lib/core) docs Documentation changes
Projects
None yet
Development

No branches or pull requests

3 participants