Skip to content

fix broken seealso docstring entries #946

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

Merged
merged 1 commit into from
Mar 31, 2020

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Mar 28, 2020

Just a simple sphinx docs PR.

@cwhanse cwhanse added this to the 0.7.2 milestone Mar 29, 2020
@wholmgren
Copy link
Member

If it works, I prefer bare function names when the function is in the same module, but what do you think?

@kandersolar
Copy link
Member Author

I don't feel strongly one way or the other. It is a little clunky to have a bunch of pvlib.submodule. everywhere, but in some cases it might help with clarity, for instance in https://pvlib-python--946.org.readthedocs.build/en/946/generated/pvlib.iam.physical.html, martin_ruiz(), ashrae(), interp(), sapm() would lose the context that sapm() is the IAM part of the SAPM.

If you prefer bare function names, that's fine and I'll update this PR tonight.

@cwhanse
Copy link
Member

cwhanse commented Mar 30, 2020

sapm() would lose the context that sapm() is the IAM part of the SAPM.

Because of the SAPM group of functions, I'd prefer full paths. It's clunky but explicit.

Copy link
Member

@wholmgren wholmgren left a comment

Choose a reason for hiding this comment

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

Ok, then I suggest merging as is. We can take up library-wide consistency in another issue.

@CameronTStark CameronTStark merged commit fef827b into pvlib:master Mar 31, 2020
@CameronTStark
Copy link
Contributor

Thanks @kanderso-nrel!

@kandersolar kandersolar deleted the seealso_fixes branch November 20, 2020 17:16
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.

DOC: some API reference pages have broken "see also" links
4 participants