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

0.1 documentation improvements #22

Merged
merged 16 commits into from
Mar 13, 2015
Merged

Conversation

wholmgren
Copy link
Member

Summarizing and copying material from #16, this PR includes improvements to

Major:

Minor:

  • Ineichen doesn’t provide info on single df output
  • function is now aoi, but docs reference getaoi throughout, except in actual function doc
  • lots of references to pvl_function not function
  • The numpydoc convention is to avoid using "See also" unless it's really important. still not great, and many broken links, but I think good enough for 0.1
  • The doc title capitalization needs to be updated.
  • Copyright needs to be updated.
  • pvlib.pvsystem.snlinverter has a long table that rtfd doesn't always format nicely small improvement, good enough
  • References to maketimestruct, makelocationstruct in pvlib.clearsky.haurwitz, maybe more.
  • pvlib.irradiance.beam_component has no documentation.
  • All modules need a better introduction to what's in them. still not great, but I think good enough for 0.1
  • pvlib.pvsystem.I_from_V has no documentation. only added warning that this may go private
  • pvlib.pvsystem.Voc_optfcn has no documentation. only added warning that this may go private
  • pvlib.pvsystem.calcparams_desoto says that module_parameters can be a Series, which, although true, is probably confusing. In any case, the doc's dict keys do not match the code's dict keys.
  • Misspelling in pvlib.pvsystem.retrieve_sam example.
  • Format equation in pvlib.pvsystem.singlediode
  • Add sphinx.ext.extlinks for issue tracking in what's new. Copied from pandas.

Does not address

Docs can be viewed here

Let me know if you think that the doc improvements are good enough for the 0.1 release or if you want to see further changes on this PR.

@bmu
Copy link
Contributor

bmu commented Mar 11, 2015

From my side, this is good for the 0.1 release.

@wholmgren
Copy link
Member Author

I think we should give @Calama-Consulting a chance for feedback on this one.

@wholmgren wholmgren mentioned this pull request Mar 12, 2015
@bmu bmu added this to the 0.1 milestone Mar 12, 2015
This was referenced Mar 12, 2015
@wholmgren
Copy link
Member Author

@dacoex the github links are now working in the test build. I will go through and add more links in either this pull request or others depending on merge order.

@dacoex
Copy link
Contributor

dacoex commented Mar 12, 2015

@wholmgren all fine.

@robwandrews
Copy link
Contributor

This looks good, @wholmgren can you address the merge conflicts and I'll merge it

@wholmgren
Copy link
Member Author

Ok, ready to merge. Closes #16.

robwandrews added a commit that referenced this pull request Mar 13, 2015
0.1 documentation improvements
@robwandrews robwandrews merged commit 698c39c into pvlib:master Mar 13, 2015
@robwandrews robwandrews mentioned this pull request Mar 13, 2015
@wholmgren wholmgren deleted the docfixes branch October 28, 2015 16:05
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.

Add What's New section to docs
4 participants