Improve the docs for unconventional_naming#387
Merged
DaAlbrecht merged 2 commits intomainfrom Apr 22, 2025
Merged
Conversation
DaAlbrecht
approved these changes
Apr 22, 2025
Collaborator
DaAlbrecht
left a comment
There was a problem hiding this comment.
Well done! I really need to try harder with documentation you are always doing a wonderful job.
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
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.
This elaborates the lint documentation for
unconventional_namingby listing what conventions are enforced, expanding the motivation section, and providing an example for plugins.Since
unconventional_namingwill likely be one of the most impactful lints, it's going to be under a lot of scrutiny. In order to avoid excessive bikeshedding and confusion, we should have a rock-solid description of what the conventions are and why we have them.