Repository navigation
GSoC feedback on the pvlib contribution process #2078
Description
This issue is for the 2024 cohort of GSoC students to document challenges related to contributing to pvlib.
The aim is to learn about the challenges that new contributors face, and hopefully be able to make changes to make the process easier.
2024 GSoC students: @echedey-ls, @IoannisSifnaios, @RDaxini
Mentors: @kandersolar, @AdamRJensen
Activity
IoannisSifnaios commentedon Jun 6, 2024
I think I am missing some documentation guidelines. E.g., when a parameter in a function is unitless, how to you denote that? Right now, I found three different ways: [-], [unitless], or nothing.
[Adam] - we should make a template function that showcases our preferences in how to write a function, e.g., function name, units, etc.
cwhanse commentedon Jun 6, 2024
I prefer
[unitless]but I don't think we've made a consensus choice.@pvlib/pvlib-core your vote?
[unitless],[-]or nothing?