Skip to content

Inconsistent usage of 'function' and 'method' #2029

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

Closed
yvonnefroehlich opened this issue Jul 28, 2022 · 2 comments · Fixed by #2043
Closed

Inconsistent usage of 'function' and 'method' #2029

yvonnefroehlich opened this issue Jul 28, 2022 · 2 comments · Fixed by #2043
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@yvonnefroehlich
Copy link
Member

It seems that the terms 'function' and 'method' are used exchangeable in the tutorial and gallery examples.

From my understanding, in Python a method belongs to a class and is associated with / called on an object. This is consistent to the API Documentation of the pygmt.Figure class.

However,

I think, we should be precise and consistent with the terminology (at least in the way that something is always either a function or a method) to avoid confusions.

@maxrjones
Copy link
Member

Good catch @yvonnefroehlich! Glad to review a PR for this if you want to submit a correction for these misnomers.

@yvonnefroehlich
Copy link
Member Author

I try to work on this over time.

@seisman seisman added the documentation Improvements or additions to documentation label Aug 8, 2022
@seisman seisman added this to the 0.8.0 milestone Aug 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants