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

Improve the "GMT Map Projections" table #3405

Open
seisman opened this issue Aug 21, 2024 · 1 comment · May be fixed by #3407
Open

Improve the "GMT Map Projections" table #3405

seisman opened this issue Aug 21, 2024 · 1 comment · May be fixed by #3407
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@seisman
Copy link
Member

seisman commented Aug 21, 2024

Here are some issues and potential improvements for the "GMT Map Projections" table:

  1. Projection code A (the first row) is incorrectly linked to code E
  2. Currently, the link to the documentation is written like:
{doc}`Albers conic equal area </projections/conic/conic_albers>`

It can be simplified to

{doc}`/projections/conic/conic_albers`

In this short version, the documentation title (Albers Conic Equal Area) will be displayed, so we don't have to maintain the projection name in two places (I think the only exception if the Cartesian projection).

  1. If we decide to use the short links as proposed in point 2, then we need to make sure the title of each projection example is suitable. Currently, we still have some inconsistencies, for example, the projection code E has a name "Azimuthal gnomonic" in the table but the example title is "Gnomonic".
  2. It would be better to use consistent title cases. Currently, we use mixed title cases. For example, "Albers Conic Equal Area" vs "Equidistant conic".

@yvonnefroehlich Are you OK with working on this issue?

@yvonnefroehlich
Copy link
Member

yvonnefroehlich commented Aug 21, 2024

The points 3. and 4. are probably also relevant for the upstream GMT documentation.

Just the have an overview:

For v0.13.0 -> v0.14.0

For v0.14.0

  • DOC/projections: Make projection name consistent gmt#8567 -> first discuss upstream
    • Make projection names consistent - keep or remove term "projection" -> separate PR
    • Make projection names consistent - identical term: following the GMT table -> separate PR
  • Similar PyGMT PR to make projection names consistent with GMT docs -> v0.14.0

@seisman seisman added this to the 0.13.0 milestone Aug 21, 2024
@yvonnefroehlich yvonnefroehlich modified the milestones: 0.13.0, 0.14.0 Sep 4, 2024
@seisman seisman removed this from the 0.14.0 milestone Sep 5, 2024
@yvonnefroehlich yvonnefroehlich modified the milestone: 0.14.0 Sep 5, 2024
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
2 participants