Skip to content
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

remove mention that non-underscored symbols denote public API #40145

Merged
merged 1 commit into from
Apr 3, 2021

Conversation

KristofferC
Copy link
Sponsor Member

@KristofferC KristofferC commented Mar 22, 2021

Ref #40131 (comment)

This is barely used in Base nor in almost any package I've read at read so it seems odd to have in the style guide.

@tpapp
Copy link
Contributor

tpapp commented Mar 23, 2021

I agree that it is misleading (as it could be taken to imply that names without _ are part of the API), nevertheless _ and doulble __ are used for something.

For me it usually signals the intention that something is really a very internal implementation detail like Base.Cartesian._nloops or Base.IteratorsMD.__inc. Since some people use it that way, maybe some reference to that could be kept in the style guide.

Copy link
Sponsor Member

@vtjnash vtjnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having knowledge of some functions in base (_hypot) that "violate" this, I think we should just delete it. We occasionally use this to indicate a version of the function that is more "low-level" or "internal," but even that classification seems a judgement call, and not necessarily a stricture to highlight in the docs

@simeonschaub simeonschaub merged commit 4076e87 into master Apr 3, 2021
@simeonschaub simeonschaub deleted the kc/no_underscore branch April 3, 2021 06:20
ElOceanografo pushed a commit to ElOceanografo/julia that referenced this pull request May 4, 2021
antoine-levitt pushed a commit to antoine-levitt/julia that referenced this pull request May 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants