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.

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

Documentation review and refactoring #1

Open
5 tasks
papachristoumarios opened this issue Aug 1, 2019 · 0 comments
Open
5 tasks

Documentation review and refactoring #1

papachristoumarios opened this issue Aug 1, 2019 · 0 comments
Assignees

Comments

@papachristoumarios
Copy link
Collaborator

Please do a review and refactor documentation. Some tasks include the following

  • Do an editorial review (spell checking, grammar checking, duplicate tables etc.)
  • Make sure you give robust examples to the potential user as how the outputs of the X module look like. For example, for the ner entities give a text from a law and then give the corresponding schema of entities as they reside in the database
  • For CLI scripts, it is useful to provide standard help functionality through argparse help variable as well as extend it inside the corresponding wiki page. You can also make a makefile to autogenerate the help pages by putting the results of script.py -h to predefined locations in the markdown file and setup CI to auto-build them.
  • If there are references to books etc., please add them under a ## References subsection.
  • BONUS: Use graphics and diagrams to make your narrative better.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants