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

short term doc fixes #16

Closed
wholmgren opened this issue Mar 3, 2015 · 3 comments
Closed

short term doc fixes #16

wholmgren opened this issue Mar 3, 2015 · 3 comments
Milestone

Comments

@wholmgren
Copy link
Member

A list of doc fixes that we may consider before an initial release:

  • Add more to the homepage, probably stuff from README.py.
  • Describe the relation to PVPMC, PVLIB-Matlab.
  • Make a text link for the tutorials instead of my usual url dump.
  • Different page for each module?

Any other relatively easy and important doc fixes?

@jforbess
Copy link
Contributor

jforbess commented Mar 9, 2015

Issues found in docs, likely from auto-gen content that hasn't been updated in code? Perhaps not all of these qualify as easy to fix before release:

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

@wholmgren
Copy link
Member Author

Thanks.

The numpydoc convention is to avoid using "See also" unless it's really important. I think that we can follow that rule now now that the library structure is in better shape.

More issues:

  • The doc title capitalization needs to be updated.
  • Copyright needs to be updated.
  • pvlib.pvsystem.snlinverter has a poorly formatted table.
  • 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.
  • pvlib.pvsystem.I_from_V has no documentation.
  • pvlib.pvsystem.Voc_optfcn has no documentation.
  • pvlib.pvsystem.calcparams_desoto says that module_parameters can be a Series, which, although true, is probably confusing (does anybody really use a Series as a dict?). 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
  • pvlib.pvsystem.systemdef as described in meta, location, and systemdef philosophy #17
  • pvlib.tmy.readtmy2 refers to a metadata struct instead of a dict. Could be addressed in TMY loading improvements #7.

This was referenced Mar 10, 2015
@bmu bmu added this to the 0.1 milestone Mar 12, 2015
@robwandrews
Copy link
Contributor

Closed from #22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants