Skip to content

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Sep 30, 2025

Description of proposed changes

Make the doc pages for the Box abd Pattern classes 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.Figure class.
-> issue #4138

Preview:

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.17.0 milestone Sep 30, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Sep 30, 2025
@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 30, 2025
@yvonnefroehlich yvonnefroehlich changed the title Use always 'Parameters' Make the doc pages for the Box abd Pattern classes consistent Sep 30, 2025
@weiji14 weiji14 mentioned this pull request Sep 30, 2025
43 tasks
@weiji14 weiji14 changed the title Make the doc pages for the Box abd Pattern classes consistent Make the doc pages for the Box and Pattern classes consistent Oct 1, 2025
@weiji14
Copy link
Member

weiji14 commented Oct 1, 2025

If possible it would be nice to remove the "Attribute" section, as there is not entery.

The Attributes section was added in #2402, and it seems to count @property methods that start with an underscore. Will need to update the code here:

{% if attributes %}
.. rubric:: Attributes
{% for item in attributes %}
.. autoproperty::
{{ objname }}.{{ item }}
{% endfor %}
{% endif %}

If you change that L7 from {% if attributes %} to {% if '_aliases' not in attributes %}, the Attributes section should be hidden for these Param classes.

@weiji14 weiji14 merged commit 947749e into main Oct 2, 2025
23 of 24 checks passed
@weiji14 weiji14 deleted the make-params-class-docs-consistent branch October 2, 2025 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants