Skip to content

Conversation

eemcmullan
Copy link
Contributor

@eemcmullan eemcmullan commented May 1, 2021

Description of proposed changes

Added three files to examples/projections/cyl for the three different oblique mercator projections. Included a brief definition of oblique mercator projections, descriptions for each option, as well as working code examples. This is in response to issue #1073. Please let me know if something needs to be fixed; I would be more than happy to change it!

Fixes #1073

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 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

@welcome
Copy link

welcome bot commented May 1, 2021

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
  • No matter what, we are really grateful that you put in the effort to do this! 🎉

@michaelgrund
Copy link
Member

Thanks for opening this PR @eemcmullan. Unfortunately it seems like @willschlitzer started to work on this topic this morning in #1250. Maybe you can bundle up your efforts?

@eemcmullan
Copy link
Contributor Author

@michaelgrund Ahh I see that now. Of course, I can reach out to him about bundling!

I reviewed these suggestions, and appreciate the feedback! Thank you for the improvements.

Co-authored-by: Will Schlitzer <[email protected]>
@maxrjones
Copy link
Member

Thanks for submitting this pull request! Could you please add links to these projection examples in the projection table as part of this pull request? The source text for the projection table is in examples/projections/table/README.txt. There are three lines (L56, L58, and L60) that need to be updated, for example:

     - Oblique Mercator, 1: origin and azim

will link to the first example if it is changed to this:

     -:doc:`Oblique Mercator, 1: origin and azim </projections/cyl/cyl_oblique_mercator_1>`

@seisman seisman added the documentation Improvements or additions to documentation label May 4, 2021
@seisman seisman added this to the 0.4.0 milestone May 4, 2021
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR looks good to me. Thanks, @eemcmullan.

@michaelgrund @willschlitzer Please give it approval if you're OK with the PR.

Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for this addition, @eemcmullan!

@eemcmullan
Copy link
Contributor Author

I was happy to do so! Thanks all for your help! @willschlitzer @seisman @michaelgrund @meghanrjones

@seisman
Copy link
Member

seisman commented May 5, 2021

@meghanrjones Please give it a final review and feel free to merge it with your admin permission, since the original issue #1073 was opened by you.

@maxrjones maxrjones merged commit ccf3046 into GenericMappingTools:master May 5, 2021
@welcome
Copy link

welcome bot commented May 5, 2021

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…#1251)

Co-authored-by: Will Schlitzer <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add an example for Oblique Mercator projection
6 participants