Conversation
|
@copilot Please update the docstrings in |
There was a problem hiding this comment.
Pull request overview
Adds a dedicated Technical Reference page documenting GMT/PyGMT unit codes (plot vs distance units) and updates API documentation to reference this centralized unit documentation.
Changes:
- Added a new Technical Reference page
techref/units.mddescribing supported plot and distance unit codes. - Included the new units page in the Technical Reference toctree.
- Updated
pygmt.grdprojectparameter docs to reference the new units documentation instead of repeating unit lists inline.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
pygmt/src/grdproject.py |
Replaces inline unit-code lists with links to the new units Technical Reference page/sections. |
doc/techref/units.md |
New documentation page enumerating plot (dimension) and distance unit codes. |
doc/techref/index.md |
Adds units.md to the Technical Reference toctree so it is built and discoverable. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…stance.py to reference units docs Agent-Logs-Url: https://github.com/GenericMappingTools/pygmt/sessions/db4bb9d5-8c02-4ea8-94c9-eed70904cb89 Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/GenericMappingTools/pygmt/sessions/db4bb9d5-8c02-4ea8-94c9-eed70904cb89 Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Done in commit fd93a03. Updated the docstrings in all four files to reference the new |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…r section anchors Agent-Logs-Url: https://github.com/GenericMappingTools/pygmt/sessions/64c0dfeb-428c-4258-ad81-a452e1d8d4c8 Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/GenericMappingTools/pygmt/sessions/8ed1ab66-2e61-4f3c-945b-c299cb5d19c6 Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
…riptions" This reverts commit a24e532.
seisman
changed the title
seisman
changed the title
Preview:
Technical reference:
Generated API pages: