Skip to content

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Mar 22, 2025

Description of proposed changes

Relate to GenericMappingTools/pygmt#3857 (comment)

Reminders

  • Make sure that your code follows our style. Use the other functions/files as a basis.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Describe changes to function behavior and arguments in a comment below the function declaration.
  • If adding new functionality, add a detailed description to the documentation and/or an example.

@yvonnefroehlich yvonnefroehlich added the documentation Improve documentation label Mar 22, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 22, 2025
@joa-quim
Copy link
Member

Don't know why you want to change it. It's day/night, not day/light.

@yvonnefroehlich
Copy link
Member Author

Don't know why you want to change it. It's day/night, not day/light.

We worked on the PyGMT docs and came cross that both "day/night" and "day/light" are used (GenericMappingTools/pygmt#3857 (comment)) in the GMT docs, please see https://docs.generic-mapping-tools.org/dev/solar.html.
My interpretation was that "day/light" refers to all four options, i.e. day-night terminator and the civil, nautical and astronomical twilights. But I am not sure if this is an official definition or formulation and, if this os directly clear for everybody. At least we should handle it consistent across the documentation and examples, which is the aim of this PR.

@joa-quim
Copy link
Member

I don't really case if it is day/night or day-night, but please do not changes day nights by day lights.

@yvonnefroehlich
Copy link
Member Author

I don't really case if it is day/night or day-night, but please do not changes day nights by day lights.

Hm. I aggree that, using "day-night" and "day-light" may be confusing for users. However, at the beginning of the GMT docs (https://docs.generic-mapping-tools.org/dev/solar.html) there is currently written:

Plot day-light terminators and other sunlight parameters

So, I am a unsure how to continue here (or close this PR?). At least the formulations should be consistent across the GMT and PyGMT docs.

@seisman
Copy link
Member

seisman commented Apr 2, 2025

Maybe we should just go with day-night?

@joa-quim
Copy link
Member

joa-quim commented Apr 2, 2025

Hm. I aggree that, using "day-night" and "day-light" may be confusing for users. However, at the beginning of the GMT docs (https://docs.generic-mapping-tools.org/dev/solar.html) there is currently written:

Plot day-light terminators and other sunlight parameters

Honestly, I don't find it so confusing (and that I know, no one complained) but yes, that entry line is better stated as day-night

@yvonnefroehlich
Copy link
Member Author

Now I changed "day-light" consistently to "day-night".

@seisman seisman merged commit 9d78b4d into GenericMappingTools:master Apr 8, 2025
4 of 5 checks passed
@yvonnefroehlich yvonnefroehlich deleted the update-solar-daynightterm branch April 8, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improve documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants