LADI
/
py-zope.interface
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move the @provider example into the right section 

Explain that implements()/implementsOnly()/classProvides() not only
should not be "preferred", but are entirely not functional on Python 3.

(These notes should probably use some Sphinx directive to stand out
better, but I'm not well versed in Sphinx and I don't know which one I
should use.)
This commit is contained in:
Marius Gedminas 2019-11-11 18:19:18 +02:00
parent 4d722f3642
commit 14dad79724
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/api/declarations.rst
View File

@ -37,7 +37,7 @@ implementer_only
implements
----------
(The `implementer` decorator is preferred to this.)
(Does not work on Python 3. Use the `implementer` decorator instead.)
.. autofunction:: implements
@ -45,7 +45,7 @@ implements
implementsOnly
--------------
(The `implementer_only` decorator is preferred to this.)
(Does not work on Python 3. Use the `implementer_only` decorator instead.)
.. autofunction:: implementsOnly
@ -335,11 +335,16 @@ Removing an interface that is provided through the class is not possible:
classProvides
-------------
(The `provider` decorator is preferred to this.)
(Does not work on Python 3. Use the `provider` decorator instead.)
.. autofunction:: classProvides
provider
--------
.. autoclass:: provider
For example:
.. doctest::
@ -379,12 +384,6 @@ Which is equivalent to:
['IFoo']
provider
--------
.. autoclass:: provider
moduleProvides
--------------