CI: Require at least one code block separator for example files in the Style Checks workflow#2810
Merged
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
weiji14
reviewed
Nov 16, 2023
Member
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?
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Member
Author
Done in 8752ef2. |
weiji14
approved these changes
Nov 16, 2023
Member
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.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Member
Author
|
@yvonnefroehlich Maybe you can give this PR another review? |
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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