Make the doc pages for the Box and Pattern classes consistent#4131
Merged
Conversation
This reverts commit 5c341e7.
Member
The Attributes section was added in #2402, and it seems to count pygmt/doc/_templates/autosummary/class.rst Lines 7 to 14 in 35f06da If you change that L7 from |
weiji14
reviewed
Oct 1, 2025
This reverts commit b9c6b45.
weiji14
approved these changes
Oct 2, 2025
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
Make the doc pages for the
BoxabdPatternclasses consistent, to use "Parameters" as section.If possible it would be nice to remove the "Attribute" section, as there is not entery; but keep it for the
pygm.Figureclass.-> issue #4138
Preview:
BoxPatternFigure(should still have the "Attribute" section)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 command is:
/format: automatically format and lint the code