Skip to content

Should we say "coast" module, or "coast" method? #1828

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
seisman opened this issue Mar 17, 2022 · 2 comments · Fixed by #1858
Closed

Should we say "coast" module, or "coast" method? #1828

seisman opened this issue Mar 17, 2022 · 2 comments · Fixed by #1858
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Milestone

Comments

@seisman
Copy link
Member

seisman commented Mar 17, 2022

In GMT, coast is called a "module", which makes sense because GMT is a CLI program. In PyGMT, sometimes we say "the coast method", but sometimes we also say "the coast module" (for example, https://www.pygmt.org/dev/get-started/first_figure.html).

In the Python world, a module usually means a Python file with some functions, and one can import the functions in the module using from xxmodule import yyfunc, but that's not the case for a PyGMT "module". I'm afraid it may cause some confusion for non-GMT users.

Should we not say "the coast module", and consitenly say "the coast method" instead?

@seisman seisman added the question Further information is requested label Mar 17, 2022
@maxrjones
Copy link
Member

I agree with using Python-oriented language in the PyGMT docs (i.e., methods/functions) unless specifically referring to the GMT CLI.

@seisman seisman added this to the 0.6.1 milestone Mar 18, 2022
@seisman seisman added documentation Improvements or additions to documentation help wanted Helping hands are appreciated and removed question Further information is requested labels Mar 25, 2022
@willschlitzer
Copy link
Contributor

I think "method" words better than "module" to align this with Python lingo.

michaelgrund added a commit that referenced this issue Mar 31, 2022
This PR addresses #1828 and replaces the term "coast" module by "coast" method.
@michaelgrund michaelgrund linked a pull request Mar 31, 2022 that will close this issue
6 tasks
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 help wanted Helping hands are appreciated
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants