Inconsistent syntax for projections in documentation

[yvonnefroehlich]

For some of the [Py]GMT projections the syntax is inconsistent between the PyGMT overview table and the specific documentation page, e.g.:

• Mercator projection
• Transverse Mercator projection
• Cylindrical stereographic
• Equidistant cylindrical

[yvonnefroehlich]

I could work on this, but I can't grant to finish it immediately...

I think it would be good to also submit a PR for the upstream GMT documentation, as there are also typos for some projections in the overview table or the specific documentation sections. Here is a list of typos I have found so far:

• Lambert azimuthal equal area (A): / missing
• Polar (P): ] to much
• Transverse Mercator (T): adjust syntax in overview table
• Mercator (M): adjust syntax in overview table

[yvonnefroehlich]

@GenericMappingTools/pygmt-maintainers do you expect me to get this into the PyGMT v0.8.0 release, or should we leave this issue as good first issue and bump it back to a later release?

[willschlitzer]

@yvonnefroehlich In general we try to leave the good first issue issues until we get close to our next release, and then we get them done shortly before a PR. I submitted one for some of the issues above.

I'm not sure about the inconsistencies in polar and lambert azimuthal equal area; I see the inconsistencies in slashes/brackets between the GMT and PyGMT documentation, but I don't think the PyGMT syntax is necessarily the incorrect one.

[yvonnefroehlich]

@yvonnefroehlich In general we try to leave the good first issue issues until we get close to our next release, and then we get them done shortly before a PR. I submitted one for some of the issues above.

Thanks @willschlitzer for this background information and directly submitting a PR. (My question was not meant in a way that you or somebody else should immediately work on this.)

I'm not sure about the inconsistencies in polar and lambert azimuthal equal area; I see the inconsistencies in slashes/brackets between the GMT and PyGMT documentation, but I don't think the PyGMT syntax is necessarily the incorrect one.

Correct. Partly the upstream GMT table or documentation contains the typos (please see my comment #2059 (comment)). Thus, we also need a PR for the upstream documentation 🙂.

[yvonnefroehlich]

@GenericMappingTools/pygmt-maintainers I have started working on this in #2269.