File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -48,6 +48,7 @@ Developer Documentation
4848 developing
4949 command-options
5050 command-wrappers
51+ specs/commands
5152
5253Project Goals
5354-------------
Original file line number Diff line number Diff line change 1+ =======
2+ example
3+ =======
4+
5+ This is a specification for the ``example `` command object. It is not intended
6+ to be a complete template for new commands since other actions, options
7+ and/or arguments may be used. You can include general specification information
8+ before the commands below. This information could include links to related material
9+ or descriptions of similar commands.
10+
11+ [example API name] [example API version]
12+
13+ example create
14+ --------------
15+
16+ Create new example
17+
18+ .. program :: example create
19+ .. code :: bash
20+
21+ os example create
22+ < name>
23+
24+ .. describe :: <name>
25+
26+ New example name
27+
28+ example delete
29+ --------------
30+
31+ Delete example(s)
32+
33+ .. program :: example delete
34+ .. code :: bash
35+
36+ os example delete
37+ < example> [< example> ...]
38+
39+ .. describe :: <example>
40+
41+ Example to delete (name or ID)
42+
43+ example list
44+ ------------
45+
46+ List examples
47+
48+ .. program :: example list
49+ .. code :: bash
50+
51+ os example list
52+
53+ example set
54+ -----------
55+
56+ Set example properties
57+
58+ .. program :: example set
59+ .. code :: bash
60+
61+ os example set
62+ [--name < new-name> ]
63+ < example>
64+
65+ .. option :: --name <new-name >
66+
67+ New example name
68+
69+ .. describe :: <example>
70+
71+ Example to modify (name or ID)
72+
73+ example show
74+ ------------
75+
76+ Display example details
77+
78+ .. program :: example show
79+ .. code :: bash
80+
81+ os example show
82+ < example>
83+
84+ .. describe :: <example>
85+
86+ Example to display (name or ID)
Original file line number Diff line number Diff line change 1+ =============
2+ Command Specs
3+ =============
4+
5+ Specifications for new commands, objects and actions are listed below.
6+ These specifications have not been implemented. See
7+ :doc: `Command List <../command-list >` for implemented commands and
8+ :doc: `Command Structure <../commands >` for implemented objects and actions.
9+
10+ It is optional to propose a specifications patch for new commands,
11+ objects and actions here before submitting the implementation. Once your
12+ specifications patch merges then you may proceed with the implementation.
13+ Your implementation patches should move applicable portions of the
14+ specifications patch to the official :doc: `Command List <../command-list >`
15+ and :doc: `Command Structure <../commands >` documentation.
16+
17+ Objects Specs
18+ -------------
19+
20+ Add specifications for new objects based on the ``example `` object.
21+
22+ * ``example ``: (**example API name **) example object description
23+
24+ Actions Specs
25+ -------------
26+
27+ Add specifications for new actions based on the ``example `` action.
28+
29+ * ``example `` - example action description
30+
31+ Commands Specs
32+ --------------
33+
34+ Add specifications for new commands based on the commands for the
35+ ``example `` object. The ``example `` commands are not intended to
36+ be a complete template for new commands since other actions, options
37+ and/or arguments may be used.
38+
39+ .. toctree ::
40+ :glob:
41+ :maxdepth: 2
42+
43+ command-objects/*
You can’t perform that action at this time.
0 commit comments