Uh oh!
There was an error while loading. Please reload this page.
Improve docstring of x2sys_init and x2sys_cross - #930
Conversation
Uh oh!
There was an error while loading. Please reload this page.
seisman
commented
Feb 19, 2021
I see more tiny issues in the x2sys_cross documentation. Do you want to also fix those tiny issues in this PR? |
maxrjones
commented
Feb 19, 2021
Sure, I can do that. |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
I just converted this PR to draft to save CI resources. |
maxrjones
commented
Feb 19, 2021
@seisman, is there a reason for this module to be in pygmt/, in contrast to the other modules which are in pygmt/src? |
seisman
commented
Feb 19, 2021
It should be in See #832 (comment) and #807 (comment). |
Uh oh!
There was an error while loading. Please reload this page.
weiji14
left a comment
There was a problem hiding this comment.
It should be in
src/, but we haven't decided if we wantx2sys_initandx2sys_crossin one filesrc/x2sys.py, or two filessrc/x2sys_init.pyandsrc/x2sys_cross.py.See #832 (comment) and #807 (comment).
Just on this, maybe better to have them in two separate files, since there are other x2sys_* modules too which may need to be wrapped in the future. Do we want to do the x2sys move before, during, or after this PR?
Uh oh!
There was an error while loading. Please reload this page.
maxrjones
commented
Feb 19, 2021
I agree about separate files and would prefer making that change during or after this PR to avoid conflicts and extra effort. |
weiji14
commented
Feb 19, 2021
Before or after? I can do one before but you'll need to resolve some merge conflicts, or I can open one after this one is merged. I presume this PR is basically done already? |
maxrjones
commented
Feb 19, 2021
I realize now my language was confusing. By 'during' I really meant 'as part of', but in remembering the 'keep PR's small' policy it seems after is best. As far as I can tell this PR is done. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
seisman
commented
Feb 20, 2021
/format |
1 similar comment
maxrjones
commented
Feb 20, 2021
/format |
seisman
commented
Feb 20, 2021
@meghanrjones |
maxrjones
commented
Feb 20, 2021
All lines locally appear to be 79 characters or less and my branch is up to date. Should I request a re-run on the style checks? |
seisman
commented
Feb 20, 2021
Lines 297 and 298 are too long. |
Description of proposed changes
This fixes the bullet list in the
speedparameter description in the x2sys_cross docs in order to suppress this sphinx build warning:Fixes #
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version