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

Add ghi_clear to glossary #2397

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

RDaxini
Copy link
Contributor

@RDaxini RDaxini commented Feb 24, 2025

@RDaxini RDaxini added this to the v0.11.3 milestone Feb 24, 2025
@RDaxini
Copy link
Contributor Author

RDaxini commented Feb 24, 2025

How about a whatsnew entry along the lines of:

Added or modified definitions of the following glossary terms:
- `ghi_clear`
- ...
- ...

Whatsnew entry probably not necessary if this PR is the only glossary change, but I expect we will have further additions and/or modifications in 11.3 so maybe a single entry that lists these together would be helpful?

@cwhanse
Copy link
Member

cwhanse commented Feb 24, 2025

A single bullet in the Documentation section would be suitable to list all changes to the glossary, I think. If one change isn't enough to merit a whatsnew note, are two changes? or five? Better to list the change, I think.

Copy link
Contributor

@echedey-ls echedey-ls left a comment

Choose a reason for hiding this comment

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

LGTM!!, minor comment below.
As an idea, you could also put the See :term: ... in irradiance.dni and irradiance.dni, which do use it (but I think it's fine as is, I don't like redirecting users for such an small description).

@RDaxini
Copy link
Contributor Author

RDaxini commented Feb 25, 2025

See :term: ... in irradiance.dni and irradiance.dni, which do use it

This should (eventually) happen #2311 so I won't do it here

Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardise variable name for clearsky GHI and DNI, add to glossary
3 participants