-
Notifications
You must be signed in to change notification settings - Fork 224
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
Description for the "columns" arguments is missing #764
Comments
The documentation is automatically generated from the docstrings in the Python codes, see
The description of the |
opened a pull request with the suggested changes (according to your comment @seisman ). |
Reopening this because the "columns" description is missing for I'm marking this as a good first issue as it should be easy enough to just copy and paste the "columns" description from https://github.com/GenericMappingTools/pygmt/blob/v0.3.0/pygmt/src/plot.py to https://github.com/GenericMappingTools/pygmt/blob/v0.3.0/pygmt/src/plot3d.py. |
I'm not sure if we discussed it before (github search shows nothing). Is "columns" a good alias for -i option? GMT provides both -i and -o, for selecting columns of input and output, respectively (see https://docs.generic-mapping-tools.org/latest/std-opts.html). GMT uses Should we follow the GMT convention? If we choose |
I think the comment you're looking for is this:
Originally posted by @seisman in #666 (comment) We kept
Originally posted by @weiji14 in #666 (comment) Since renaming the alias for |
Great searching skills! 😃
Yes to me. |
Sounds good. I'll update the milestone on it. |
Do we all agree that we should use |
|
For reference, |
Ok, let's go with |
…6.0) As discussed in #764, this PR replaces the **columns** parameter by **incols** for plot.py and adds the deprecation .
Please describe what could be improved about this page or the typo/mistake that you found:
I would suggest to add a short note regarding the supported syntax for the
columns
option when using e.g. a data file as input, something likecolumns = [0, 1]
if the x values are stored in the first column and y values in the second one, note: zero-based indexing is used).I tried to fix that suggestion by my own following the instructions given in the Contributing Guidelines under Editing the Documentation, however, the corresponding
.rst
file is not available in thedoc
folder.The text was updated successfully, but these errors were encountered: