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

Add example for leading underscore in function names #59

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

sorliem
Copy link

@sorliem sorliem commented Sep 11, 2020

Add an example for leading underscores in function names. I've seen examples of python-like leading underscores in function names to denote a function is private to the module.

@eksperimental
Copy link

I would go with
Bad: def _parse_contents(data)

Good:

@doc false
def parse_contents(data)

@sorliem
Copy link
Author

sorliem commented Sep 14, 2020

Updated. How does that look?

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.

None yet

2 participants