DOC: Add a page for common parameters in the Technical Reference section#3844
Merged
DOC: Add a page for common parameters in the Technical Reference section#3844
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
The purpose of this PR is to add a new documentation page for common parameters in the Technical Reference section, addressing issue #3843.
- Added a common parameters page with a glossary block for documenting the "verbose" parameter.
- Updated the Technical Reference toctree to include the new page.
- Simplified the verbose parameter description in the decorators module to reference the full usage documentation.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/techref/common_parameters.md | Added new documentation page for common parameters. |
| doc/techref/index.md | Updated toctree to include the new page. |
| pygmt/helpers/decorators.py | Updated verbose parameter docstring to link to the full usage. |
28 tasks
michaelgrund
approved these changes
Mar 24, 2025
yvonnefroehlich
approved these changes
Mar 24, 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.
Address #3843.
This PR only adds the
verboseparameters. Other parameters can be added in separate PRs (one parameter per PR).Preview: