You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Please do a review and refactor documentation. Some tasks include the following
## References
subsection.The text was updated successfully, but these errors were encountered: