-
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
CI: Require at least one code block separator for example files in the Style Checks workflow #2810
Conversation
…e Style Checks workflow
966b44b
to
b276a41
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also mention this # %%
rule in https://github.com/GenericMappingTools/pygmt/blob/v0.10.0/doc/contributing.md#code-style, and link to #2660?
Co-authored-by: Wei Ji <[email protected]>
Done in 8752ef2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor spelling issue, otherwise ok. Might be good to have someone else proofread the documentation.
Co-authored-by: Wei Ji <[email protected]>
@yvonnefroehlich Maybe you can give this PR another review? |
Co-authored-by: Yvonne Fröhlich <[email protected]>
Description of proposed changes
Add a step in the Style Checks workflow, to ensure all example files have at least one code block separator
# %%
.Address #2805 (comment).
See https://github.com/GenericMappingTools/pygmt/actions/runs/6864172516/job/18665360359?pr=2810. If I revert the changes in PR #2805, the workflow fails with the following error:
which means the added step works as expected.
Reminders
make format
andmake check
to 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