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

Document the -R+U option in the global -R #7606

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Document the -R+U option in the global -R #7606

wants to merge 3 commits into from

Conversation

joa-quim
Copy link
Member

@joa-quim joa-quim commented Jul 4, 2023

Fix #7537

@joa-quim joa-quim requested a review from PaulWessel July 4, 2023 15:41
@PaulWessel
Copy link
Member

Think you are mistaken here. The +U|u at the end of a grid does that scaling, but it is not the +u that belongs to -R. So the docs you linked is the right place and should not be added to -R

@joa-quim
Copy link
Member Author

joa-quim commented Jul 4, 2023

I added stuff about +U not +u (which was already there). So, where do we document +U? The CookBook is not the right place for it.

@PaulWessel
Copy link
Member

Well, first half of cookbook is documentation and the examples etc are cookbook. We have tons of explanations (pen, fill, text, etc) in the technical reference section. We have extensive discussion of netCDF files and how to pull out a named variable, how to scale CPT z-values etc. This is no different (+U|uunit is also used for CPTs).

@joa-quim
Copy link
Member Author

joa-quim commented Jul 4, 2023

But we already have +u in -R. Why not have the +U too? Relying in the CookBook to find an obscure -R flag is the same ~= nothing.

@PaulWessel
Copy link
Member

In -R, +uk means xmin/xmax/ymin/ymax are projected coordinates given in km and we scale by 1000 and then inverse project to get lon/lat.

As grid file modifier, +uk means scale grid xmin/xmax/ymin/ymax by 1000, but no inverting takes place. +u|U is also available for things like -Cmy.cpt+Uk.

We can chat about these things at the summit and make a list of tasks that are good things for some of our collaborators to deal with. I also think we should break the cookbook into separate documents: Technical Reference for all this stuff, and Gallery for the examples.

@joa-quim
Copy link
Member Author

joa-quim commented Jul 4, 2023

https://documentation.divio.com/

@Esteban82
Copy link
Member

Could this be merged?

@joa-quim
Copy link
Member Author

joa-quim commented May 6, 2024

We should either merge or close this. Paul was not very favorable because this option applies to more than -R but I still feel that if don't do this partial documentation it won't be mentioned anywhere.

@seisman
Copy link
Member

seisman commented May 7, 2024

I agree with Paul that this is not the correct place to document -R. Perhaps it's better to document it at line 35 in the same file?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document basemap -R...+U
4 participants