diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-05 15:05:51 -0600 |
| commit | 9e64f600b65d99ea5a83051372372512be698b1b (patch) | |
| tree | 7409d3646ff4a0fa349b8e71daa5959cbde342bf /docs/features | |
| parent | 4c97ab03825151fd85a875617fde7d0534c9cb72 (diff) | |
| download | cmd2-git-9e64f600b65d99ea5a83051372372512be698b1b.tar.gz | |
Added a walkthrough of constructing a simple application to the overview
For #709
Diffstat (limited to 'docs/features')
| -rw-r--r-- | docs/features/commands.rst | 4 | ||||
| -rw-r--r-- | docs/features/history.rst | 9 | ||||
| -rw-r--r-- | docs/features/index.rst | 6 | ||||
| -rw-r--r-- | docs/features/initialization.rst | 4 | ||||
| -rw-r--r-- | docs/features/multiline_commands.rst (renamed from docs/features/multiline.rst) | 0 | ||||
| -rw-r--r-- | docs/features/transcripts.rst (renamed from docs/features/transcript.rst) | 5 |
6 files changed, 22 insertions, 6 deletions
diff --git a/docs/features/commands.rst b/docs/features/commands.rst new file mode 100644 index 00000000..3eec2373 --- /dev/null +++ b/docs/features/commands.rst @@ -0,0 +1,4 @@ +Commands +======== + +How to create a command with a ``do_command`` method, diff --git a/docs/features/history.rst b/docs/features/history.rst index cbd3f3e6..9fd881d4 100644 --- a/docs/features/history.rst +++ b/docs/features/history.rst @@ -1,8 +1,15 @@ Command History =============== +For Developers +-------------- + - Describe how cmd2 tracks history -- describe the uses of the built in history command - how persistent history works - differences in history and bash shell history (we only store valid commands in history) - reference the public code structures we use to store history + +For Users +--------- + +- describe the uses of the built in history command diff --git a/docs/features/index.rst b/docs/features/index.rst index ae2933e2..b8ee6b20 100644 --- a/docs/features/index.rst +++ b/docs/features/index.rst @@ -4,6 +4,7 @@ Features .. toctree:: :maxdepth: 1 + commands generating_output argument_processing prompt @@ -14,10 +15,11 @@ Features settings completion os - multiline + multiline_commands disable_commands clipboard - transcript + transcripts + initialization hooks plugins scripting diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst new file mode 100644 index 00000000..b13d5bc8 --- /dev/null +++ b/docs/features/initialization.rst @@ -0,0 +1,4 @@ +Initialization +============== + +Show how to properly initialize a ``cmd2`` app, showing parameters, sequencing, etc. diff --git a/docs/features/multiline.rst b/docs/features/multiline_commands.rst index 85a92bb2..85a92bb2 100644 --- a/docs/features/multiline.rst +++ b/docs/features/multiline_commands.rst diff --git a/docs/features/transcript.rst b/docs/features/transcripts.rst index 089ab704..eeb51534 100644 --- a/docs/features/transcript.rst +++ b/docs/features/transcripts.rst @@ -1,6 +1,5 @@ -======================== -Transcript based testing -======================== +Transcripts +=========== A transcript is both the input and output of a successful session of a ``cmd2``-based app which is saved to a text file. With no extra work on your |