Skip to content

Commit 03f5e20

Browse files
committed
docs: move command documentation above the delayed lookup explanation
The example doesn't demonstrate the command documentation so it's confusing to have it be the last thing before the example. Signed-off-by: Jeff Mahoney <jeffm@suse.com>
1 parent 82b6466 commit 03f5e20

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

‎doc-source/api_changes.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ Public / Protected Namespace
4141
The use of ``_`` as a prefix for protected members of classes is now expected and will be enforced during ``make test`` if `pylint <https://www.pylint.org/>`_ is installed. In the example below, several internal members and methods of `MyClass` have been renamed to indicate that they are
4242
protected.
4343

44+
Command documentation
45+
---------------------
46+
47+
In earlier versions of crash-python, commands were documented using the docstring of the Command itself. This has changed to use the docstring of the module instead. More details can be found in :class:`~crash.command.Command` and :class:`~crash.command.ArgumentParser`. The format of the docstring is `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ and is parsed using `Sphinx <http://www.sphinx-doc.org/en/master/index.html>`_. The documentation is used for both the user guide and the application command help. This is an area that is subject to change in the future.
48+
4449
New mechanism for delayed lookups
4550
---------------------------------
4651

@@ -54,11 +59,6 @@ The current version of crash-python uses the :class:`crash.util.symbol` module t
5459

5560
- There are accessors beyond attributes. The :class:`.DelayedCollection` family of classes all have :meth:`~.DelayedCollection.__getattr__`, :meth:`~DelayedCollection.__getitem__`, and :meth:`~DelayedCollection.get` defined, so they can be accessed as attribute names, dictionary keys, or by function call. The latter two can be used with any name, but the attribute names cannot be used for symbols that start with ``__``.
5661

57-
Command documentation
58-
---------------------
59-
60-
In earlier versions of crash-python, commands were documented using the docstring of the Command itself. This has changed to use the docstring of the module instead. More details can be found in :class:`~crash.command.Command` and :class:`~crash.command.ArgumentParser`. The format of the docstring is `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ and is parsed using `Sphinx <http://www.sphinx-doc.org/en/master/index.html>`_. The documentation is used for both the user guide and the application command help. This is an area that is subject to change in the future.
61-
6262
Example
6363
-------
6464

0 commit comments

Comments
 (0)