Skip to content

Commit 4f1a5d9

Browse files
committed
[#1810] Adding a Learn More section to the console introduction
This introduces the idea of having short "intro" chapters for each component, followed by lots of related docs. This is a model that we largely want to follow in the components and in the framework book itself (we also need more in-context cross-linking between documents). I've also updated a few document titles to be more descriptive.
1 parent 761975b commit 4f1a5d9

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

components/console/introduction.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,3 +401,9 @@ returns the returned code from the command (return value from command's
401401
something and display feedback to the user. So, instead of calling a
402402
command from the Web, refactor your code and move the logic to a new
403403
class.
404+
405+
Learn More!
406+
-----------
407+
408+
* :doc:`/components/console/usage`
409+
* :doc:`/components/console/single_command_tool`

components/console/single_command_tool.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. index::
22
single: Console; Single command application
33

4-
How to build an Application with a single Command
5-
=================================================
4+
How to build an Application that is a single Command
5+
====================================================
66

77
When building a command line tool, you may not need to provide several commands.
88
In such case, having to pass the command name each time is tedious. Fortunately,

components/console/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. index::
22
single: Console; Usage
33

4-
Console Usage
5-
=============
4+
Using Console Commands, Shortcuts and Built-in Commands
5+
=======================================================
66

77
In addition to the options you specify for your commands, there are some
88
built-in options as well as a couple of built-in commands for the console component.

0 commit comments

Comments
 (0)