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

[DOC]: params & units guidelines in contributing page #2248

Merged
merged 15 commits into from
Dec 10, 2024

Conversation

echedey-ls
Copy link
Contributor

@echedey-ls echedey-ls commented Oct 9, 2024

Improve "contributing" guidelines on how to find parameter names and their units.

In coordination with style decided in #2234.

Makes two changes to index pages of functions, to avoid being too verbose and a typo.

Links

@echedey-ls echedey-ls changed the title Docstring guidelines params&units [DOC]: params & units guidelines in contributing page Oct 9, 2024
@echedey-ls echedey-ls marked this pull request as ready for review October 9, 2024 16:20
Copy link
Contributor

@RDaxini RDaxini left a comment

Choose a reason for hiding this comment

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

Nice job. Couple of suggestions + one point about the link to the variables page

docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com>
@echedey-ls echedey-ls marked this pull request as ready for review November 27, 2024 22:59
@echedey-ls
Copy link
Contributor Author

Ready for review (thx Dax for reminding me xD). Preview linked in PR body.
Assigning to v0.11.2 for now.

@echedey-ls echedey-ls added this to the v0.11.2 milestone Nov 27, 2024
Copy link
Member

@AdamRJensen AdamRJensen left a comment

Choose a reason for hiding this comment

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

What a great addition this will be 🥳

docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
docs/sphinx/source/contributing/style_guide.rst Outdated Show resolved Hide resolved
echedey-ls and others added 4 commits November 28, 2024 11:58
Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

LGTM! Whatsnew entry?

@echedey-ls
Copy link
Contributor Author

Whatsme added!!
@AdamRJensen can you review and approve (if possible) the PR? As of now (requesting changes) I think it can't get merged.

Copy link
Member

@AdamRJensen AdamRJensen left a comment

Choose a reason for hiding this comment

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

Awesome contribution @echedey-ls 🥳

@kandersolar kandersolar merged commit f61eec6 into pvlib:main Dec 10, 2024
21 checks passed
@echedey-ls echedey-ls deleted the docstring-guidelines-units-etc branch December 11, 2024 13:10
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.

Standarizing pvlib typesetting of units - standarization for common variables?
4 participants