Increased level of self-documentation of code #17765
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for prettier ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
fisker
approved these changes
Jul 29, 2025
fisker
reviewed
Sep 11, 2025
commit: |
jgerigmeyer
added a commit
to oddbird/prettier
that referenced
this pull request
Sep 17, 2025
* main: (87 commits) Unify `require()` and `import()` formatting logic (prettier#17902) Allow `parser.preprocess` to return a `Promise` (prettier#17679) Fix config file names order (prettier#17685) Fix format of comments around `ChainExpression` (prettier#17723) Cleanup cspell.json (2025-09-11) (prettier#17901) Add automated job to clean cspell.json yearly (prettier#17900) Add missing parentheses to arrow function in `TSInstantiationExpression` (prettier#17724) Increased level of self-documentation of code (prettier#17765) Fix crash on CSS custom properties (prettier#17899) doc: update related-projects.md (prettier#17804) docs: add monaco-prettier integration (prettier#17815) Build: stop transforming optional chaining (prettier#17863) Remove unnecessary path parameters (prettier#17867) chore(deps): update dependency nano-spawn to v1.0.3 (prettier#17898) chore(deps): update dependency knip to v5.63.1 (prettier#17896) chore(deps): update dependency concurrently to v9.2.1 (prettier#17887) chore(deps): update dependency tinybench to v5.0.1 (prettier#17892) chore(deps): update dependency @mdx-js/react to v3.1.1 (prettier#17885) chore(deps): update dependency @angular/compiler to v20.3.0 (prettier#17894) chore(deps): update dependency flow-parser to v0.281.0 (prettier#17895) ...
jgerigmeyer
added a commit
to oddbird/prettier
that referenced
this pull request
Sep 18, 2025
* main: (140 commits) chore(deps): update dependency esbuild to v0.25.10 (prettier#17913) chore(deps): update dependency sdbm to v3 (prettier#17914) Prevent matching mixin calls inside arguments (prettier#17903) chore(deps): update dependency oxc-parser to v0.89.0 (prettier#17912) Improve emoji width measurement (prettier#17813) Unify `require()` and `import()` formatting logic (prettier#17902) Allow `parser.preprocess` to return a `Promise` (prettier#17679) Fix config file names order (prettier#17685) Fix format of comments around `ChainExpression` (prettier#17723) Cleanup cspell.json (2025-09-11) (prettier#17901) Add automated job to clean cspell.json yearly (prettier#17900) Add missing parentheses to arrow function in `TSInstantiationExpression` (prettier#17724) Increased level of self-documentation of code (prettier#17765) Fix crash on CSS custom properties (prettier#17899) doc: update related-projects.md (prettier#17804) docs: add monaco-prettier integration (prettier#17815) Build: stop transforming optional chaining (prettier#17863) Remove unnecessary path parameters (prettier#17867) chore(deps): update dependency nano-spawn to v1.0.3 (prettier#17898) chore(deps): update dependency knip to v5.63.1 (prettier#17896) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
While this code is functionally correct, there is room for readability and maintainability improvements in that it is difficult to tell from the code alone what files are included in the ignoredFilenames.
In particular, it is difficult to understand why a file such as mcmod.info is in the list without other knowledge.
Therefore, I suggest adding a comment explaining why each file is excluded and what file it is. This will make it easier for future maintainers to understand the intent.
Checklist
docs/directory).changelog_unreleased/*/XXXX.mdfile followingchangelog_unreleased/TEMPLATE.md.