summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-14 22:42:03 -0700
committerkotfu <kotfu@kotfu.net>2020-02-14 22:42:03 -0700
commit3448438f27c5b040e3e4c742a880cf660695e563 (patch)
tree5a2ad3d143008b8e221be723afc3ea4f44a566b7 /docs/api
parent909bf0c1cc94fff58773aa57bd2ded233cd53a6d (diff)
downloadcmd2-git-3448438f27c5b040e3e4c742a880cf660695e563.tar.gz
Finish attribute documentation for Statement class
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/parsing.rst35
1 files changed, 30 insertions, 5 deletions
diff --git a/docs/api/parsing.rst b/docs/api/parsing.rst
index 4ee6606d..c79c8f6b 100644
--- a/docs/api/parsing.rst
+++ b/docs/api/parsing.rst
@@ -8,11 +8,6 @@ cmd2.parsing
The name of the command after shortcuts and macros have been expanded
- .. attribute:: multiline_command
-
- If the command is a multi-line command, the name of the command will be
- in this attribute. Otherwise, it will be an empty string.
-
.. attribute:: args
The arguments to the command as a string with spaces between the words,
@@ -43,6 +38,36 @@ cmd2.parsing
this string, but there will be embedded newlines where the user hit
return to continue the command on the next line.
+ .. attribute:: multiline_command
+
+ If the command is a multi-line command, the name of the command will be
+ in this attribute. Otherwise, it will be an empty string.
+
+ .. attribute:: terminator
+
+ If the command is a multi-line command, this attribute contains the
+ termination character entered by the user to signal the end of input
+
+ .. attribute:: suffix
+
+ Any characters present between the input terminator and the output
+ redirection tokens.
+
+ .. attribute:: pipe_to
+
+ If the user piped the output to a shell command, this attribute contains
+ the entire shell command as a string. Otherwise it is an empty string.
+
+ .. attribute:: output
+
+ If output was redirected by the user, this contains the redirection
+ token, i.e. ``>>``.
+
+ .. attribute:: output_to
+
+ If output was redirected by the user, this contains the requested destination with
+ quotes preserved.
+
.. autoclass:: cmd2.parsing.StatementParser
:members: