WIP Search docs and sdk to find undocumented libs #777

Closed
wants to merge 2 commits into from

2 participants

@gregglind
Mozilla member

Usage:

~/gits/addon-sdk $ python \
python-lib/cuddlefish/docs/completeness.py lib/sdk/ \
doc/module-source/sdk | less

This outputs some reports:

  • Modules that have documentation
  • Documentation with no libraries
  • exported things that have no tags
  • things that have no associated code.

TODO:

  • check that reporting is accurate.
  • use better methods than my regexes
  • generalize for package paths?
  • decide on format of report? HTML?
  • decide if should have a 'nocode=true' to allow ignore?
@gregglind
Mozilla member
gregglind added some commits Feb 8, 2013
@gregglind gregglind WIP Search docs and sdk to find undocumented libs
Usage:

~/gits/addon-sdk $ python \
python-lib/cuddlefish/docs/completeness.py lib/sdk/ \
doc/module-source/sdk | less

This outputs some reports:

* Modules that have documentation
* Documentation with no libraries
* exported things that have no <api> tags
* <api> things that have no associated code.

TODO:

* check that reporting is accurate.
* use better methods than my regexes
* generalize for package paths?
* decide on format of report?  HTML?
* decide if <api> should have a 'nocode=true' to allow ignore?
ae9aa5f
@gregglind gregglind empty files for undoc-d modules 3281904
@erikvold

the cfx docs command was removed and the docs are on mdn now, so I don't think this patch is relevant any longer.

@erikvold erikvold closed this Sep 10, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment