StrepHit
StrepHit copied to clipboard
Improve documentation
Missing features in the current Mediawiki page, as compared to what I consider a gold standard, i.e., http://docs.python-requests.org/en/latest/api/ ordered by priority:
- usage commands (only needed for prominent functions of the NLP pipeline, e.g., https://www.mediawiki.org/wiki/StrepHit#strephit.commons.pos_tag_module);
- arguments type, cf. https://www.mediawiki.org/wiki/StrepHit#strephit.annotation.post_job_module
- internal classes anchors;
- source code links;
- return type anchors/links.
Points 3,4 and 5 above are to be implemented yet.
More comments. These are the minimal requirements to make the documentation more usable:
- do not generate non-browsable lists, e.g., https://www.mediawiki.org/wiki/StrepHit#Subpackages
- avoid empty sections, e.g., https://www.mediawiki.org/wiki/StrepHit#Module_contents