LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

Updated Daemon docstring formatting (markdown)

Alex Grin 2018-03-13 16:07:38 -04:00
parent 12384863a7
commit d45ab4d609
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Daemon-docstring-formatting.md

@ -1,8 +1,12 @@
## Please make sure that all the docstrings for the jsonrpc commands should adhere to this format so that it can be properly parsed by the scripts which convert it to documentation
All the docstrings for the jsonrpc commands must adhere to this format so they can be parsed by the scripts which generate the documentation. The script is [here](https://github.com/lbryio/lbry/blob/master/scripts/gen_docs.py) if you want to make changes.
### Please note that the colons(:) are important.
There are examples at the bottom if you learn best that way, or if you like copy-pasting.
### First line after the `"""` in the docstring is a short description of what the function does
*Please note that the colons(:) are important.*
### First Line
The first line after the `"""` in the docstring is a short description of what the function does.
### Subheading `Usage:`
It should start with the word "Usage:", then in the next line list out the command name, then the arguments(as prescribed by [docopts library](http://docopt.org/)). It is of the following format
@ -37,9 +41,6 @@ Returns:
Response signature, it may be a list, dict, Boolean etc.
```
### If you think the scripts is missing some important functionality it can be changed [here](https://github.com/lbryio/lbry/blob/master/scripts/gen_docs.py) or you can open an issue in [lbryio/lbry](https://github.com/lbryio/lbry/issues/new) and tag @hackrush01 in the comments with the snippet which is not being correctly parsed by the scripts.
## A few examples
### Example 1
```