search

SunSpecOrangeButton / pyoblib

Orange Button Python Library
Apache License 2.0
14 stars 19 forks source link

Edit docstrings for readthedocs #140

Closed cwhanse closed 5 years ago

cwhanse commented 5 years ago

Various formatting and editorial changes, primarily for correct rendering on readthedocs

codecov-io commented 5 years ago

Codecov Report

Merging #140 into master will decrease coverage by 0.32%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #140      +/-   ##
==========================================
- Coverage   89.49%   89.17%   -0.33%     
==========================================
  Files          25       25              
  Lines        2466     2466              
==========================================
- Hits         2207     2199       -8     
- Misses        259      267       +8
Impacted Files Coverage Δ
oblib/taxonomy_types.py 97.87% <ø> (ø) :arrow_up:
oblib/taxonomy_units.py 78.68% <ø> (-1.64%) :arrow_down:
oblib/taxonomy.py 94.8% <ø> (ø) :arrow_up:
oblib/data_model.py 79.79% <100%> (ø) :arrow_up:
oblib/constants.py 85.71% <100%> (ø) :arrow_up:
oblib/validator.py 80% <0%> (-3.34%) :arrow_down:
oblib/tests/test_data_model.py 99.23% <0%> (-0.26%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 447b33e...23336ec. Read the comment docs.

cwhanse commented 5 years ago

I'm still working this, got readthedocs to build on my fork, so no need to review until I confirm this PR is ready.

cwhanse commented 5 years ago

Is this text accurate? For oblib.util module

Contains basic utility methods used throughout the library. Please note that this file is not exported as part of the module so if a method has an external signature place it somewhere else.

cwhanse commented 5 years ago

Ready for review. Built at readthedocs . The changes are from scanning the API reference page for formatting issues.

cwhanse commented 5 years ago

The pattern name (type) : description doesn't appear to parse for readthedocs. If that's the question. For type names I prefer the python name for the type e.g. str over the word string, datetime rather than date time. I just think it helps the programmer.