Skip to content

Consistent use of underscores #111

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

Open
larsmans opened this issue Mar 31, 2016 · 2 comments
Open

Consistent use of underscores #111

larsmans opened this issue Mar 31, 2016 · 2 comments

Comments

@larsmans
Copy link
Collaborator

As noted at #110 and #105, underscores should be consistently applied to mark public/private boundaries, and we should have this documented somewhere. We have:

  • public API
  • private functions (with _)
  • private modules (with _), but "semi-public" functions within them that are used in other modules

Ping @LourensVeen. Maybe put this in the contributing code docs?

@LourensVeen
Copy link
Member

Yes, that would be a good place to put some explanation. I'll look at it, if you want to assign me to this issue go ahead.

@larsmans
Copy link
Collaborator Author

Yes, please work on this; I'm refactoring other parts of the code.

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

No branches or pull requests

2 participants