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

Fix typos in psconvert in the file figure.py #2048

Merged
merged 4 commits into from
Aug 13, 2022
Merged

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

This PR aims to fix typos in the API documentation of pygmt.Figure.psconvert in the file figure.py.

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 commands are:

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

@yvonnefroehlich
Copy link
Member Author

This PR is more or less complete from my side. 

For the sake of consistency I want[ed] to add dots at the end of the bullet points in the section 'main features' of the API References. However, I could not figure out where / in which file I have to make the change. In the pygmt/doc/index.rst file, I only found:

.. _api:
API Reference
=============
.. automodule:: pygmt
.. currentmodule:: pygmt
Plotting

I would be happy if one could help me out 🙂 . If people agree this change makes sense, I can open a new PR or add this to this PR.

@yvonnefroehlich yvonnefroehlich changed the title WIP: Fix typos in psconvert in the file figure.py Fix typos in psconvert in the file figure.py Aug 12, 2022
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Aug 12, 2022
@seisman seisman added this to the 0.8.0 milestone Aug 12, 2022
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Aug 12, 2022
@seisman
Copy link
Member

seisman commented Aug 12, 2022

This PR is more or less complete from my side. 

For the sake of consistency I want[ed] to add dots at the end of the bullet points in the section 'main features' of the API References. However, I could not figure out where / in which file I have to make the change. In the pygmt/doc/index.rst file, I only found:

.. _api:
API Reference
=============
.. automodule:: pygmt
.. currentmodule:: pygmt
Plotting

I would be happy if one could help me out 🙂 . If people agree this change makes sense, I can open a new PR or add this to this PR.

They are here https://github.com/GenericMappingTools/pygmt/blob/main/pygmt/__init__.py.

@seisman seisman merged commit 80b3ecb into main Aug 13, 2022
@seisman seisman deleted the fix-typos-in-api-psconvert branch August 13, 2022 13:23
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 13, 2022
@yvonnefroehlich
Copy link
Member Author

They are here https://github.com/GenericMappingTools/pygmt/blob/main/pygmt/__init__.py.

Thanks @seisman! I have made the change in PR #2055.

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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.

3 participants