Skip to content

Latest commit

 

History

History
68 lines (62 loc) · 3.88 KB

File metadata and controls

68 lines (62 loc) · 3.88 KB

code2docs — Docstring Coverage

🟡 Overall coverage: 79.1%

Category Documented Total Coverage
Functions 202 255 79.2%
Classes 44 56 78.6%

Per-Module Breakdown

Module Functions Classes Coverage
__main__ 0/0 0/0 🟢 100%
analyzers 0/0 0/0 🟢 100%
analyzers.dependency_scanner 0/0 3/3 🟢 100%
analyzers.docstring_extractor 0/0 2/2 🟢 100%
analyzers.endpoint_detector 0/0 2/2 🟢 100%
analyzers.project_scanner 1/1 1/1 🟢 100%
base 0/0 2/2 🟢 100%
cli 13/13 1/1 🟢 100%
code2docs 1/1 0/0 🟢 100%
config 0/0 7/7 🟢 100%
examples.advanced_usage 0/0 0/0 🟢 100%
examples.quickstart 0/0 0/0 🟢 100%
formatters 0/0 0/0 🟢 100%
formatters.badges 2/2 0/0 🟢 100%
formatters.markdown 0/0 1/1 🟢 100%
formatters.toc 3/3 0/0 🟢 100%
generators 1/1 0/0 🟢 100%
generators._registry_adapters 0/0 2/14 🔴 14%
generators._source_links 0/0 1/1 🟢 100%
generators.api_changelog_gen 0/0 2/2 🟢 100%
generators.api_reference_gen 0/0 1/1 🟢 100%
generators.architecture_gen 0/0 1/1 🟢 100%
generators.changelog_gen 0/0 2/2 🟢 100%
generators.code2llm_gen 2/2 1/1 🟢 100%
generators.config_docs_gen 0/0 1/1 🟢 100%
generators.contributing_gen 0/0 1/1 🟢 100%
generators.coverage_gen 0/0 1/1 🟢 100%
generators.depgraph_gen 0/0 1/1 🟢 100%
generators.examples_gen 0/0 1/1 🟢 100%
generators.getting_started_gen 0/0 1/1 🟢 100%
generators.mkdocs_gen 0/0 1/1 🟢 100%
generators.module_docs_gen 0/0 1/1 🟢 100%
generators.org_readme_gen 0/0 1/1 🟢 100%
generators.readme_gen 1/1 1/1 🟢 100%
llm_helper 1/1 1/1 🟢 100%
registry 0/0 1/1 🟢 100%
sync 0/0 0/0 🟢 100%
sync.differ 0/0 2/2 🟢 100%
sync.updater 0/0 1/1 🟢 100%
sync.watcher 1/1 0/0 🟢 100%

Undocumented Items

  • generators._registry_adapters.ApiChangelogAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:120)
  • generators._registry_adapters.ApiReferenceAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:38)
  • generators._registry_adapters.ArchitectureAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:72)
  • generators._registry_adapters.ConfigDocsAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:187)
  • generators._registry_adapters.ContributingAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:204)
  • generators._registry_adapters.CoverageAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:104)
  • generators._registry_adapters.DepGraphAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:88)
  • generators._registry_adapters.ExamplesAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:137)
  • generators._registry_adapters.GettingStartedAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:170)
  • generators._registry_adapters.MkDocsAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:154)
  • generators._registry_adapters.ModuleDocsAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:55)
  • generators._registry_adapters.ReadmeGeneratorAdapter (/home/tom/github/wronai/code2docs/code2docs/generators/_registry_adapters.py:13)