search

executablebooks / sphinx-external-toc

A sphinx extension that allows the site-map to be defined in a single YAML file
https://sphinx-external-toc.readthedocs.io
MIT License
32 stars 18 forks source link

🔧 MAINTAIN: Updated `api` docstrings #64

Closed ZviBaratz closed 2 years ago

ZviBaratz commented 2 years ago

Updated the api module docstrings.

codecov[bot] commented 2 years ago

Codecov Report

Merging #64 (34e8d98) into main (6566942) will increase coverage by 0.01%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #64      +/-   ##
==========================================
+ Coverage   90.75%   90.77%   +0.01%     
==========================================
  Files           6        6              
  Lines         660      661       +1     
==========================================
+ Hits          599      600       +1     
  Misses         61       61
Flag Coverage Δ
pytests 90.77% <100.00%> (+0.01%) :arrow_up:

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

Impacted Files Coverage Δ
sphinx_external_toc/api.py 93.33% <100.00%> (+0.07%) :arrow_up:

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 6566942...34e8d98. Read the comment docs.