cobbler / libcobblersignatures

Library for working with cobbler signatures
GNU General Public License v2.0
4 stars 5 forks source link

Docs: Add Docstring to all properties #33

Closed SchoolGuy closed 3 years ago

SchoolGuy commented 3 years ago

This will add documentation to all properties we have in our files and fix the sed error we have on main.

codecov[bot] commented 3 years ago

Codecov Report

Merging #33 (5a9d48d) into main (3aacf43) will increase coverage by 0.07%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #33      +/-   ##
==========================================
+ Coverage   51.52%   51.60%   +0.07%     
==========================================
  Files           4        4              
  Lines         654      655       +1     
==========================================
+ Hits          337      338       +1     
  Misses        317      317              
Flag Coverage Δ
unittests 51.60% <100.00%> (+0.07%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
libcobblersignatures/models/osbreed.py 89.58% <100.00%> (ø)
libcobblersignatures/models/osversion.py 87.87% <100.00%> (+0.10%) :arrow_up:
libcobblersignatures/signatures.py 100.00% <100.00%> (ø)

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 0e3d009...5a9d48d. Read the comment docs.

SchoolGuy commented 3 years ago

Sorry for the force push but I did want to hide my incorrect removal of the link.

SchoolGuy commented 3 years ago

Let's either squash this after the review and before merging or squash the whole PR.

SchoolGuy commented 3 years ago

I cleaned the Git History so it is not that cluttered.

SchoolGuy commented 3 years ago

No objects. Thus merging now.