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

Docs: list wrong number of code path events #17968

Closed
1 task done
Richardinho opened this issue Jan 7, 2024 · 1 comment · Fixed by #17969
Closed
1 task done

Docs: list wrong number of code path events #17968

Richardinho opened this issue Jan 7, 2024 · 1 comment · Fixed by #17969
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation

Comments

@Richardinho
Copy link
Contributor

Docs page(s)

https://eslint.org/docs/latest/extend/custom-rules#accessing-code-paths

What documentation issue do you want to solve?

section reads:

ESLint analyzes code paths while traversing AST. You can access code path objects with five events related to code paths.
However, there are 7 events, according to this page https://eslint.org/docs/latest/extend/code-path-analysis

What do you think is the correct solution?

Change first page to give the correct number of events.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

@Richardinho Richardinho added the documentation Relates to ESLint's documentation label Jan 7, 2024
@mdjermanovic mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jan 7, 2024
@mdjermanovic
Copy link
Member

ESLint analyzes code paths while traversing AST. You can access code path objects with five events related to code paths.
However, there are 7 events, according to this page https://eslint.org/docs/latest/extend/code-path-analysis

Change first page to give the correct number of events.

Thanks for finding this, a PR to fix the docs is welcome 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants