Improve, cleanup API-docs

[noissue]
pulp · Feb 11, 2019 · 87ceba4 · 87ceba4
1 parent d80e828
commit 87ceba4
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 11 deletions.
diff --git a/docs/api-reference/stages.rst b/docs/api-reference/stages.rst
@@ -24,7 +24,7 @@ DeclarativeVersion
 
 .. autoclass:: pulpcore.plugin.stages.DeclarativeContent
    :no-members:
-   :members: pipeline_stages
+   :members: get_or_create_future
 
 
 .. _stages-api:
@@ -47,16 +47,12 @@ Artifact Related Stages
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: pulpcore.plugin.stages.ArtifactDownloader
-   :special-members: __call__
 
 .. autoclass:: pulpcore.plugin.stages.ArtifactSaver
-   :special-members: __call__
 
 .. autoclass:: pulpcore.plugin.stages.RemoteArtifactSaver
-   :special-members: __call__
 
 .. autoclass:: pulpcore.plugin.stages.QueryExistingArtifacts
-   :special-members: __call__
 
 
 .. _content-stages:
@@ -65,14 +61,11 @@ Content Related Stages
 ^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: pulpcore.plugin.stages.ContentSaver
-   :special-members: __call__
    :private-members: _pre_save, _post_save
 
 .. autoclass:: pulpcore.plugin.stages.QueryExistingContents
-   :special-members: __call__
 
 .. autoclass:: pulpcore.plugin.stages.ResolveContentFutures
-   :special-members: __call__
 
 
 .. _content-association-stages:
@@ -81,8 +74,6 @@ Content Association and Unassociation Stages
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: pulpcore.plugin.stages.ContentAssociation
-   :special-members: __call__
 
 .. autoclass:: pulpcore.plugin.stages.ContentUnassociation
-   :special-members: __call__
 
diff --git a/docs/plugin-writer/concepts/subclassing/serializers.rst b/docs/plugin-writer/concepts/subclassing/serializers.rst
@@ -34,7 +34,7 @@ serializer needs to add that field as well.
           )
 
       class Meta:
-            fields = ContentSerializer.Meta.fields + ('relative_path',)
+            fields = SingleArtifactContentSerializer.Meta.fields + ('relative_path',)
             model = FileContent
 
 Help Text

diff --git a/pulpcore/plugin/stages/api.py b/pulpcore/plugin/stages/api.py
@@ -230,6 +230,11 @@ class EndStage(Stage):
     """
 
     async def __call__(self):
+        """
+        This method drains items from the last queue and drops them.
+
+        Especially it does not try to put items into the nonexistent next queue.
+        """
         # We overwrite __call__ here to avoid trying to put None in `self._out_q`.
         async for _ in self.items():  # noqa
             pass