SecBSD/ports
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

SecBSD's official ports repository

Browse source
This commit is contained in:
purplerain 2023-08-16 22:26:55 +00:00
commit 2c0afcbbf3
Signed by: purplerain
GPG key ID: F42C07F07E2E35B7
64331 changed files with 5339189 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
textproc/argparse-manpage/pkg/DESCR Normal file
View file

@ -0,0 +1,15 @@
ArgumentParser instance -> manual page.
Avoid documenting your Python script arguments on two places!
This is typically done in an argparse.ArgumentParser help configuration
(help=, description=, etc.), and also in a manually crafted manual page.
The good thing about an ArgumentParser objects is that it actually provides a
traversable "tree-like" structure, with all the necessary info needed to
automatically generate documentation, for example in a groff typesetting system
(manual pages).
And this is where this project can help.
There are two supported ways to generate the manual, either script it using the
installed command argparse-manpage, or via setup.py build automation (with a
slight bonus of automatic manual page installation with setup.py install).