-
-
Notifications
You must be signed in to change notification settings - Fork 4.9k
docs: add missing punctuation in document #19161
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
Conversation
|
|
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Tanujkanti4441
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @lumirlumir, thanks for the PR!
There is inconsistency regarding full stop punctuation in docs pages like:
We have full stop here in list

And there are few more place where punctuation is not consistent in the same list such as:
in manage-issues page.

or in work-on-issue page

i think we should also make it consistent on other pages.
|
Hello, @Tanujkanti4441 Thank you for the detailed review! I've actually been checking for other missing punctuation in the documentation. If that's okay, would it be alright to add the missing punctuation to all the other document pages as well? I've noticed that many sentences in the lists are missing punctuation. So far, I've reviewed about a third of the documents and found missing punctuation in more than 10 pages. By the time I'm done, I estimate that there could be issues in over 20 pages. Now, I'm wondering how best to proceed with this task:
It would be helpful to get your advice on this. I'll follow your recommendation! Once the direction is decided, I'll let you know when I expect to finish this work. |
IMHO, it's better to update this PR because on the basis of what i have noticed in docs i am assuming even the number of pages would be large but the content to update (adding punctuation) won't be that much in per page. But still let's ask other @eslint/eslint-team members that how they would like the PR to be made. |
|
I think it's fine to update this PR will all of the changes. Just note that not all bullets required periods, only those that are complete sentences. |
|
Thanks, @Tanujkanti4441 and @nzakas. I think I can finish this by the end of the week. Until then, I'll keep it as a draft. Once the process is complete, I'll ping the reviewers! |
governance.md|
Hello, @Tanujkanti4441 @nzakas, I've added as many missing punctuation marks as I could. I only added them to complete sentences, not to incomplete ones. Additionally, the |
nzakas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!


Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Hello, I've added missing punctuation in
governance.md.There is always punctuation at the end of the lists (represented with
*in Markdown), as shown in the screenshot below. However, the items I added were missing it.Is there anything you'd like reviewers to focus on?
The sentences in the list above are incomplete, so it’s possible to omit the periods. However, since periods are used consistently throughout the Markdown page, I’m debating whether to include them here as well.