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:09:15 -04:00
parent b31817f07c
commit fff0fc6c6b
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
Daemon-docstring-formatting.md

@ -4,11 +4,14 @@ There are [examples](#example-1) below for those who learn best that way, or who
*Please note that the colons(:) are important.* *Please note that the colons(:) are important.*
### First Line
## First Line
The first line after the `"""` in the docstring is a short description of what the function does. The first line after the `"""` in the docstring is a short description of what the function does.
### Subheading `Usage:`
## 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 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
``` ```
@ -17,7 +20,8 @@ Usage:
[<optional_arg2> | --optional_arg2=<optional_arg2>] [<optional_arg2> | --optional_arg2=<optional_arg2>]
``` ```
### Subheading `Options:` ## Subheading `Options:`
It should start with the word "Options:", then in the next line It should start with the word "Options:", then in the next line
1) If there are no arguments just write "None" 1) If there are no arguments just write "None"
2) Otherwise list out the command name followed by two dashes --, then ":", after that type of argument in parenthesis `(type)` and short description of the argument after a blank space. Please list out all of the arguments be it required, optional or Boolean as it is required by the api. 2) Otherwise list out the command name followed by two dashes --, then ":", after that type of argument in parenthesis `(type)` and short description of the argument after a blank space. Please list out all of the arguments be it required, optional or Boolean as it is required by the api.
@ -33,7 +37,8 @@ Options:
(Note: this ^ blank space is important) (Note: this ^ blank space is important)
``` ```
### Subheading `Returns:` ## Subheading `Returns:`
It should start with the word "Returns:", then from the next line list out the response signature that the command return. It is of the following format It should start with the word "Returns:", then from the next line list out the response signature that the command return. It is of the following format
``` ```
@ -42,7 +47,7 @@ Returns:
``` ```
### Example 1 ## Example 1
``` ```
""" """
Get blob availability Get blob availability
@ -66,7 +71,8 @@ Returns:
""" """
``` ```
### Example 2
## Example 2
``` ```
""" """
Get DHT routing information Get DHT routing information