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

Update formatting of additional pvlib publications #2011

Merged

Conversation

AdamRJensen
Copy link
Member

Not all of the "additional pvlib python publications" include a doi reference. This PR adds this and also standardizes the format of the references.

@cwhanse
Copy link
Member

cwhanse commented Apr 12, 2024

LGTM

collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
* J. S. Stein, "The Photovoltaic Performance Modeling Collaborative (PVPMC),"
2012 38th IEEE Photovoltaic Specialists Conference (PVSC),
Austin, TX, USA, 2012, pp. 003048-003052, https://doi.org/10.1109/PVSC.2012.6318225.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it more common to add the raw link in the IEEE format or DOI: 10.1109/PVSC.2012.6318225 ?

I think these dois could make use of the role :doi:``

Copy link
Member Author

Choose a reason for hiding this comment

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

DOI is certainly to be preferred.

I've switched to the doi role, though I don't exactly know the benefit

Copy link
Contributor

@echedey-ls echedey-ls Apr 12, 2024

Choose a reason for hiding this comment

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

Sorry for not being clear enough regarding the "raw link".

You can either put:

The first one is with the DOI role and the second one is the one I was referring to with "raw link".

Edit: for clarification, those are the ways they get rendered on the page.

Copy link
Member Author

Choose a reason for hiding this comment

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

The HTTP link for DOIs is fairly compact, so I don't have a strong preference for either one. Let's just go with the DOI role for this PR.

Copy link
Member

Choose a reason for hiding this comment

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

IMHO it’s not an either/or situation. As the title of this PR suggests there is or should be a standard way to format & render references, which uses the doi role that was explicitly created for this purpose. If it is not functional then it should probably be removed from the Sphinx config file. Maybe this needs to be documented somewhere?

@kandersolar kandersolar merged commit 71da245 into pvlib:main Apr 13, 2024
24 of 29 checks passed
@AdamRJensen AdamRJensen deleted the update_additional_pvlib_publications branch April 13, 2024 20:48
@kandersolar kandersolar added this to the v0.10.5 milestone Apr 15, 2024
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.

5 participants