mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-10-08 23:22:21 +02:00
add colon to parameter in docs
This commit is contained in:
@@ -87,7 +87,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -73,7 +73,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -325,7 +325,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -53,7 +53,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -53,7 +53,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -45,7 +45,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -129,7 +129,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -135,7 +135,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -77,7 +77,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -144,7 +144,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -216,7 +216,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -107,7 +107,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -97,7 +97,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -57,7 +57,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -313,7 +313,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -177,7 +177,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -101,7 +101,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -143,7 +143,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -30,7 +30,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -35,7 +35,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -83,7 +83,7 @@ Final processing to conform to the schema.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -9,7 +9,7 @@ Prints a warning message for non-fatal issues
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
message (string) text of message
|
message: (string) text of message
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ Prints an error message for fatal issues
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
message (string) text of message
|
message: (string) text of message
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
@@ -38,9 +38,9 @@ Checks for the parser's compatibility with the running OS platform.
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
mod_name (string) __name__ of the calling module
|
mod_name: (string) __name__ of the calling module
|
||||||
|
|
||||||
compatible (list) sys.platform name(s) compatible with the parser
|
compatible: (list) sys.platform name(s) compatible with the parser
|
||||||
compatible options:
|
compatible options:
|
||||||
linux, darwin, cygwin, win32, aix, freebsd
|
linux, darwin, cygwin, win32, aix, freebsd
|
||||||
|
|
||||||
|
@@ -86,7 +86,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -72,7 +72,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -324,7 +324,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -52,7 +52,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -20,7 +20,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -52,7 +52,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -44,7 +44,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -129,7 +129,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -134,7 +134,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -77,7 +77,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -144,7 +144,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -216,7 +216,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -106,7 +106,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -97,7 +97,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -56,7 +56,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -313,7 +313,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -176,7 +176,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -100,7 +100,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -143,7 +143,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -29,7 +29,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -34,7 +34,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -83,7 +83,7 @@ def process(proc_data):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
proc_data (dictionary) raw structured data to process
|
proc_data: (dictionary) raw structured data to process
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
|
@@ -9,7 +9,7 @@ def warning_message(message):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
message (string) text of message
|
message: (string) text of message
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ def error_message(message):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
message (string) text of message
|
message: (string) text of message
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
||||||
@@ -46,9 +46,9 @@ def compatibility(mod_name, compatible):
|
|||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
mod_name (string) __name__ of the calling module
|
mod_name: (string) __name__ of the calling module
|
||||||
|
|
||||||
compatible (list) sys.platform name(s) compatible with the parser
|
compatible: (list) sys.platform name(s) compatible with the parser
|
||||||
compatible options:
|
compatible options:
|
||||||
linux, darwin, cygwin, win32, aix, freebsd
|
linux, darwin, cygwin, win32, aix, freebsd
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user