docs: rename "directive comments" to "comment directives" #11268
Conversation
|
Thanks for the PR, @mrazauskas! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
View your CI Pipeline Execution ↗ for commit c694488.
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
This seems like a fine change to me 👍
Would you mind doing a search in the repo for any other instances where we use the term "directive comments" and replacing them as well? I see several code comments with this wording and we might as well switch them, too, I think
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11268 +/- ##
=======================================
Coverage 90.91% 90.91%
=======================================
Files 501 501
Lines 50869 50869
Branches 8382 8382
=======================================
Hits 46248 46248
Misses 4606 4606
Partials 15 15
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
@kirkwaiblinger Thanks for feedback. I replaced all instances I could find. |
PR Checklist
Overview
This PR only renames "directive comments" into "comment directives" in documentation.
The wording is rather similar, indeed. It seems to me that "comment directives" is the preferred naming in the ecosystem:
// @ts-expect-errorwas added to TypeScript, several internal types use the "comment directives" naming: Added @ts-expect-error to @ts-ignore directives microsoft/TypeScript#36014