Skip to content

Improve documentation #34

Open
Open
Improve documentation#34
Assignees
e-dorigatti
Labels
pull request welcome

Description

@marfox
marfox
opened on Jun 1, 2016

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.

Activity

  1. marfox
    added
    task
    on Jun 1, 2016
  2. marfox
    added this to the 1.0 Beta Release milestone on Jun 1, 2016
  3. marfox
    assigned
    e-dorigatti
    on Jun 1, 2016
  4. e-dorigatti
    added 3 commits that reference this issue on Jun 2, 2016

    #34 improved documentation

    2667b58

    #34 sphinx extension to output wikisyntax documentation

    cb36875

    #34 more documentation

    9372b61
  5. e-dorigatti
    closed this as completedon Jun 7, 2016

  6. marfox commented on Jun 13, 2016

    @marfox
    marfox
    on Jun 13, 2016
    MemberAuthor

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

  7. marfox
    reopened this on Jun 13, 2016

  8. marfox commented on Jun 13, 2016

    @marfox
    marfox
    on Jun 13, 2016
    MemberAuthor

    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
  9. e-dorigatti
    added 3 commits that reference this issue on Jun 14, 2016

    improvements to the wikisyntax writer #34

    d2ccb3f

    #34 fixed links

    0840728

    #34 fixed stlye issues and sphinx warnings

    1518b25
  10. marfox
    removed this from the 1.0 Beta Release milestone on Jun 17, 2016
  11. marfox
    added
    pull request welcome
    and removed
    task
    on Jul 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

pull request welcome

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions