Repository navigation
Fix missing and misnamed parameters in docstrings - #4968
Merged
seisman merged 1 commit intoOct 28, 2026
Merged
Conversation
- Figure.grdview: the parameter is listed as "drapegrid", but the function only accepts "drape_grid" now. - Figure.text: document "frame". - Figure.tilemap: document "monochrome", "no_clip", "projection", "frame", "verbose", "panel", "perspective" and "transparency". - pygmt.filter1d: document "data".
seisman
added
documentation
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
Some docstrings don't match the function signatures:
Figure.grdview: the parameter is listed asdrapegrid, but the signature only hasdrape_gridnow (thedrapegridalias was deprecated for removal in v0.20.0).Figure.text:frameis in the signature and the alias list but has no entry. Added$frame.Figure.tilemap:monochrome,no_clip,projection,frame,verbose,panel,perspectiveandtransparencyare explicit parameters but were not documented. Added$-placeholders for the common ones and short entries formonochromeandno_clip. Theno_cliptext follows whattest_tilemap_no_clipchecks: withno_clip=Truethe region is dropped and the whole tile extent is drawn.pygmt.filter1d: thedataparameter had no entry. Used the same wording asselect/rose.Only docstrings change. The rendered parameter lists were checked by applying the
fmt_docstringsubstitutions: no$placeholder is left, and every parameter in these four signatures now has an entry.ruff checkandruff format --checkpass on the changed files.triangulate.delaunay_triplesalso hasspacingandregistrationin its signature without docstring entries. They are left alone here because it isn't clear whether they do anything without an output grid.Preview:
Guidelines
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