IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Tutorial: improved clarity of 'How this tutorial is written' section

Browse Source
This commit is contained in:
Jason Gerard DeRose 2008-11-11 10:24:30 -07:00
parent 786c965c12
commit 1894513574
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ipalib/__init__.py
View File

@ -42,8 +42,8 @@ How this tutorial is written
The code examples in this tutorial are presented as if entered into a Python
interactive interpreter session. As such, when you create a real plugin in
a source file, a few details will be different (in addition to the fact that
you will never include the ``>>>`` nor ``...`` at the beginning of each line
of code).
you will never include the ``>>>`` nor ``...`` that the interpreter places at
the beginning of each line of code).
The tutorial examples all have this pattern:
@ -57,9 +57,9 @@ The tutorial examples all have this pattern:
>>> api.register(my_command)
>>> api.finalize()
We call `get_standard_api()` to get an *example* instance of `plugable.API`
to work with. But a real plugin will use the standard *run-time* instance
of `plugable.API`, which is available at ``ipalib.api``.
In the tutorial we call `get_standard_api()` to create an *example* instance
of `plugable.API` to work with. But a real plugin will simply use
``ipalib.api``, the standard run-time instance of `plugable.API`.
A real plugin will have this pattern:
@ -71,8 +71,7 @@ A real plugin will have this pattern:
pass
api.register(my_command)
The differences are that in a real plugin you will use the standard
``ipalib.api`` instance of `plugable.API` and that you will *not* call
As seen above, also note that in a real plugin you will *not* call
`plugable.API.finalize()`. When in doubt, look at some of the built-in
plugins for guidance, like those in `ipalib.plugins`.