canonical / craft-cli

https://canonical-craft-cli.readthedocs-hosted.com/en/latest/
GNU Lesser General Public License v3.0
9 stars 15 forks source link

docs: fix missing api reference for Emitter #212

Closed tigarmo closed 10 months ago

tigarmo commented 10 months ago

The docs were missing because of the __all__ attribute in messages.py. To get around this, craft a special purpose rst file to be used when documenting that module, explicitly asking autodoc to generate docs for Emitter and EmitterMode.

Fixes #208

codecov[bot] commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (ce2ee08) 94.76% compared to head (cc0899c) 94.77%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #212 +/- ## ======================================= Coverage 94.76% 94.77% ======================================= Files 7 7 Lines 1070 1072 +2 Branches 197 198 +1 ======================================= + Hits 1014 1016 +2 Misses 53 53 Partials 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.