openstack/python-openstackclient
Code Issues Proposed changes
a071ff91c3
python-openstackclient/doc/source/specs/commands.rst
Stephen Finucane 70170656fd doc: Correct Sphinx warnings 
- Fix option-describe typos
- Correct option and envvar markup, for commands that are using the
  reference form instead of the definition form or are marking up
  option arguments as options
- Avoid duplicate commands
- Fix some invalid docstrings
- Fix some invalid indentation
- Disable the murano plugin, which has invalid docs
- Correct issues with- and track the network-topology spec
- Include API modules in docs

Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
2017-03-28 16:41:54 +01:00

1.3 KiB
Raw Blame History

Command Specs

Specifications for new commands, objects and actions are listed below. These specifications have not been implemented. See Command List <../command-list> for implemented commands and Command Structure <../commands> for implemented objects and actions.

It is optional to propose a specifications patch for new commands, objects and actions here before submitting the implementation. Once your specifications patch merges then you may proceed with the implementation. Your implementation patches should move applicable portions of the specifications patch to the official Command List <../command-list> and Command Structure <../commands> documentation.

Objects Specs

Add specifications for new objects based on the example object.

Actions Specs

Add specifications for new actions based on the example action.

network-topology

Commands Specs

Add specifications for new commands based on the commands for the example object. The example commands are not intended to be a complete template for new commands since other actions, options and/or arguments may be used.

command-objects/*