Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand documentation for Cartesian projections #2643

Merged
merged 12 commits into from
Aug 28, 2023

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Aug 25, 2023

Description of proposed changes

This PR aims to expand the documentations of the Cartesian linear, logarithmic, and power projections regarding the scale option.

Currently, the general syntax is repeated for the scale option (lower-case letter version), as we have it for nearly all other projections. Or do we only want to state the width-height version (upper-case letter version), as is currently done for the polar projection?

For context / first mentioned: #2641 (comment)

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.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Aug 25, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone Aug 25, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as draft August 25, 2023 21:18
@yvonnefroehlich yvonnefroehlich changed the title Expand documentation for Cartesian projections WIP: Expand documentation for Cartesian projections Aug 25, 2023
@yvonnefroehlich yvonnefroehlich changed the title WIP: Expand documentation for Cartesian projections Expand documentation for Cartesian projections Aug 25, 2023
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review August 27, 2023 07:21
examples/projections/nongeo/cartesian_linear.py Outdated Show resolved Hide resolved
examples/projections/nongeo/cartesian_logarithmic.py Outdated Show resolved Hide resolved
examples/projections/nongeo/cartesian_power.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Aug 27, 2023
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Aug 28, 2023
@weiji14 weiji14 merged commit dcf1c7f into main Aug 28, 2023
@weiji14 weiji14 deleted the improve-docs-projection-linear branch August 28, 2023 21:43
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Aug 28, 2023
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.

4 participants