From 2c9e2146bcf88349a54057d3d8bb8a732a0d4883 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Wed, 10 Jun 2015 21:50:41 -0700 Subject: [PATCH] A few jobboard documentation tweaks Change-Id: I67fcfcb9e721d3293b60f04f7bebac3723b1a3ae --- doc/source/jobs.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/source/jobs.rst b/doc/source/jobs.rst index cc7f6f10..7dd73063 100644 --- a/doc/source/jobs.rst +++ b/doc/source/jobs.rst @@ -62,7 +62,8 @@ Features the previously partially completed work or begin initial work to ensure that the workflow as a whole progresses (where progressing implies transitioning through the workflow :doc:`patterns ` and - :doc:`atoms ` and completing their associated state transitions). + :doc:`atoms ` and completing their associated + :doc:`states ` transitions). - Atomic transfer and single ownership @@ -94,11 +95,12 @@ Features Usage ===== -All engines are mere classes that implement same interface, and of course it is -possible to import them and create their instances just like with any classes -in Python. But the easier (and recommended) way for creating jobboards is by -using the :py:meth:`fetch() ` function which uses -entrypoints (internally using `stevedore`_) to fetch and configure your backend +All jobboards are mere classes that implement same interface, and of course +it is possible to import them and create instances of them just like with any +other class in Python. But the easier (and recommended) way for creating +jobboards is by using the :py:meth:`fetch() ` +function which uses entrypoints (internally using `stevedore`_) to fetch and +configure your backend. Using this function the typical creation of a jobboard (and an example posting of a job) might look like: