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

Leading underscores for objects intended only for internal use #21

Closed
sadielbartholomew opened this issue Feb 23, 2024 · 0 comments · Fixed by #57
Closed

Leading underscores for objects intended only for internal use #21

sadielbartholomew opened this issue Feb 23, 2024 · 0 comments · Fixed by #57
Assignees

Comments

@sadielbartholomew
Copy link
Member

There are numerous functions marked, in their docstring, with the statement "This is an internal routine and is not used by the user." e.g:

cf-plot/cfplot/cfplot.py

Lines 3891 to 3894 in b0333d6

def check_data(field=None, x=None, y=None):
"""
| check_data - check user input contour data is correct.
| This is an internal routine and is not used by the user.

It would be ideal, for clarity to developers, to follow tradition and rename these all so they have leading underscores in their names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant