Uh oh!
There was an error while loading. Please reload this page.
CI: Require at least one code block separator for example files in the Style Checks workflow - #2810
Conversation
…e Style Checks workflow
966b44b to
b276a41Compare
weiji14
left a comment
There was a problem hiding this comment.
Also mention this # %% rule in https://github.com/GenericMappingTools/pygmt/blob/v0.10.0/doc/contributing.md#code-style, and link to #2660?
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
seisman
commented
Nov 16, 2023
Done in 8752ef2. |
weiji14
left a comment
There was a problem hiding this comment.
One minor spelling issue, otherwise ok. Might be good to have someone else proofread the documentation.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
seisman
commented
Nov 17, 2023
@yvonnefroehlich Maybe you can give this PR another review? |
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: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
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 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