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

Unclear documentation about the fixer methods #14162

Closed
gaearon opened this issue Mar 2, 2021 · 6 comments · Fixed by #15174
Closed

Unclear documentation about the fixer methods #14162

gaearon opened this issue Mar 2, 2021 · 6 comments · Fixed by #15174
Assignees
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint
Projects

Comments

@gaearon
Copy link

gaearon commented Mar 2, 2021

This is about https://eslint.org/docs/developer-guide/working-with-rules.

It mentions the range object many times:

Screenshot 2021-03-02 at 15 41 59

However, it doesn't specify what the range object actually is and what format it's in.

@gaearon gaearon added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Mar 2, 2021
@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon core Relates to ESLint's core APIs and features labels Mar 2, 2021
@nzakas nzakas added this to Needs Triage in Triage via automation Mar 2, 2021
@nzakas nzakas moved this from Needs Triage to Evaluating in Triage Mar 2, 2021
@nzakas
Copy link
Member

nzakas commented Mar 2, 2021

Range is the range property on any token or node. We could probably stand to make that clear in the docs.

Are you willing to submit a pull request to update the documentation?

@nzakas nzakas moved this from Evaluating to Ready to Implement in Triage Mar 2, 2021
@gaearon
Copy link
Author

gaearon commented Mar 2, 2021

Sure.

gaearon added a commit to gaearon/eslint that referenced this issue Mar 2, 2021
@gaearon
Copy link
Author

gaearon commented Mar 2, 2021

#14166

@nzakas nzakas moved this from Ready to Implement to Pull Request Opened in Triage Mar 5, 2021
@nzakas
Copy link
Member

nzakas commented Mar 5, 2021

Awesome, thanks!

@github-actions
Copy link

github-actions bot commented Oct 15, 2021

Oops! It looks like we lost track of this issue. @eslint/eslint-tsc what do we want to do here? This issue will auto-close in 7 days without an update.

@github-actions github-actions bot added the Stale label Oct 15, 2021
@nzakas nzakas self-assigned this Oct 16, 2021
@nzakas
Copy link
Member

nzakas commented Oct 16, 2021

I'll take this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint
Projects
Triage
Complete
Development

Successfully merging a pull request may close this issue.

2 participants