Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #34

Open
marfox opened this issue Jun 1, 2016 · 2 comments
Open

Improve documentation #34

marfox opened this issue Jun 1, 2016 · 2 comments
Assignees
@e-dorigatti
Labels
pull request welcome

Comments

@marfox
Copy link
Member

marfox commented Jun 1, 2016 •
edited
Loading

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 marfox added the task label Jun 1, 2016
@marfox marfox added this to the 1.0 Beta Release milestone Jun 1, 2016
e-dorigatti added a commit that referenced this issue Jun 2, 2016
@e-dorigatti
#34 improved documentation
2667b58
e-dorigatti added a commit that referenced this issue Jun 2, 2016
@e-dorigatti
#34 sphinx extension to output wikisyntax documentation
cb36875
e-dorigatti added a commit that referenced this issue Jun 2, 2016
@e-dorigatti
#34 more documentation
9372b61
@marfox
Copy link
Member Author

marfox commented Jun 13, 2016

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

@marfox marfox reopened this Jun 13, 2016
@marfox
Copy link
Member Author

marfox commented Jun 13, 2016

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

e-dorigatti added a commit that referenced this issue Jun 14, 2016
@e-dorigatti
improvements to the wikisyntax writer #34
d2ccb3f 
 - skipping most non-browsable lists
 - removed empty sections
 - anchors to toc after section titles
e-dorigatti added a commit that referenced this issue Jun 14, 2016
@e-dorigatti
#34 fixed links
0840728
e-dorigatti added a commit that referenced this issue Jun 14, 2016
@e-dorigatti
#34 fixed stlye issues and sphinx warnings
1518b25
@marfox marfox removed this from the 1.0 Beta Release milestone Jun 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@e-dorigatti e-dorigatti

Labels
pull request welcome
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@marfox @e-dorigatti