Skip to content

Commit

Permalink
squash: mention _CommonBase in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
happz committed Feb 20, 2023
1 parent e00562a commit c2b6dfb
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions docs/classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,24 @@ Basic

The ``Common`` class is the parent of most of the available
classes, it provides common methods for logging, running commands
and workdir handling. The ``Core`` class together with its child
classes ``Test``, ``Plan`` and ``Story`` cover the
:ref:`specification`::

Common
├── Core
│   ├── Plan
│   ├── Story
│   └── Test
├── Clean
├── Guest
├── Phase
├── Run
├── Status
├── Step
└── Tree
and workdir handling. The ``_CommonBase`` class is an actual root
of the class tree, makes sure the inheritance works correctly.
The ``Core`` class together with its child classes ``Test``,
``Plan`` and ``Story`` cover the :ref:`specification`::

_CommonBase
└── Common
├── Core
│   ├── Plan
│   ├── Story
│   └── Test
├── Clean
├── Guest
├── Phase
├── Run
├── Status
├── Step
└── Tree


Phases
Expand Down

0 comments on commit c2b6dfb

Please sign in to comment.