Resolve contradictory guidance on '.' in function names - #181
Merged
Conversation
The naming bullets said both:
* Do not use '.' (in the S3 class system, some(x) where x is class A
will dispatch to some.A).
* Prefix non-exported functions with a '.'.
Read together these contradict each other, and a reader following the
first bullet literally cannot follow the second. The intent is that the
restriction applies to exported names, where a dot risks colliding with
S3 dispatch, while a leading dot on an internal helper is the
conventional way to mark it non-exported.
Merged into a single bullet stating both the rule and its exception.
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.
The naming bullets said both:
Read together these contradict each other, and a reader following the first bullet literally cannot follow the second. The intent is that the restriction applies to exported names, where a dot risks colliding with S3 dispatch, while a leading dot on an internal helper is the conventional way to mark it non-exported.
Merged into a single bullet stating both the rule and its exception.