ZviBaratz commented 2 years ago

I was trying to get a little familiar with the code and thought I would use the opportunity to propose completed docstrings for the parser module. If this sort of contribution is welcome, I could try and do the same for the other modules.

welcome[bot] commented 2 years ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

chrisjsewell commented 2 years ago

always welcome 😄

codecov[bot] commented 2 years ago

Codecov Report

Merging #61 (d3d835f) into main (5b13190) will not change coverage. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   90.75%   90.75%           
=======================================
  Files           6        6           
  Lines         660      660           
=======================================
  Hits          599      599           
  Misses         61       61

Flag	Coverage Δ
pytests	`90.75% <100.00%> (ø)`

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

Impacted Files	Coverage Δ
sphinx_external_toc/parsing.py	`92.09% <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 5b13190...d3d835f. Read the comment docs.

welcome[bot] commented 2 years ago

Congrats on your first merged pull request in this project! :tada:
Thank you for contributing, we are very proud of you! :heart:

executablebooks / sphinx-external-toc

🔧 MAINTAIN: Updated parser docstrings #61

Codecov Report