Giter VIP home page Giter VIP logo

Comments (3)

jforbess avatar jforbess commented on June 12, 2024

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

from pvlib-python.

wholmgren avatar wholmgren commented on June 12, 2024

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 #17
  • pvlib.tmy.readtmy2 refers to a metadata struct instead of a dict. Could be addressed in #7.

from pvlib-python.

robwandrews avatar robwandrews commented on June 12, 2024

Closed from #22

from pvlib-python.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.