search

Wikidata / StrepHit

An intelligent reading agent that understands text and translates it into Wikidata statements.
https://meta.wikimedia.org/wiki/Grants:IEG/StrepHit:_Wikidata_Statements_Validation_via_References
GNU General Public License v3.0
112 stars 14 forks source link

Improve documentation #34

Open marfox opened 8 years ago

marfox commented 8 years ago

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:

  1. usage commands (only needed for prominent functions of the NLP pipeline, e.g., https://www.mediawiki.org/wiki/StrepHit#strephit.commons.pos_tag_module);
  2. arguments type, cf. https://www.mediawiki.org/wiki/StrepHit#strephit.annotation.post_job_module
  3. internal classes anchors;
  4. source code links;
  5. return type anchors/links.
marfox commented 8 years ago

Points 3,4 and 5 above are to be implemented yet.

marfox commented 8 years ago

More comments. These are the minimal requirements to make the documentation more usable:

  1. do not generate non-browsable lists, e.g., https://www.mediawiki.org/wiki/StrepHit#Subpackages
  2. avoid empty sections, e.g., https://www.mediawiki.org/wiki/StrepHit#Module_contents