This repository has been archived by the owner on Oct 28, 2019. It is now read-only.
Improve, cleanup API-docs #51
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #51 +/- ##
=======================================
Coverage 42.33% 42.33%
=======================================
Files 22 22
Lines 711 711
=======================================
Hits 301 301
Misses 410 410
Continue to review full report at Codecov.
|
asmacdo
reviewed
Feb 8, 2019
| @@ -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',) | |||
|
@asmaco I updated the PR to the latest additions to the stages API and removed the WIP status. |
mdellweg
force-pushed
the
stages_doc
branch
2 times, most recently
from
87ceba4
to
db59ed6
Compare
asmacdo
reviewed
Feb 12, 2019
| @@ -33,6 +33,10 @@ working directory setup, and database cleanup after encountering failures. | |||
| Synchronizing | |||
| ------------- | |||
|
|
|||
| .. tip:: | |||
|
|
|||
| Please consider using the high level :ref:`stages-docs` for actual implementations. | |||
There was a problem hiding this comment.
I like this-- could you remove a similar section above?
https://github.com/pulp/pulpcore-plugin/pull/51/files#diff-6419377e4fd81d7840183ac963bd1047L6
asmacdo
reviewed
Feb 12, 2019
pulpcore/plugin/stages/api.py
Outdated
| """ | ||
| This method drains items from the last queue and drops them. | ||
|
|
||
| Especially it does not try to put items into the nonexistent next queue. |
There was a problem hiding this comment.
Optional nitpick: s/Especially/Importantly/
asmacdo
reviewed
Feb 12, 2019
| @@ -91,7 +91,8 @@ class RemoveDuplicates(Stage): | |||
| """ | |||
| Stage allows plugins to remove content that would break repository uniqueness constraints. | |||
|
|
|||
| This stage is expected to be added by the DeclarativeVersion. See that class for example usage. | |||
| This stage is expected to be added by the | |||
| :class:`~pulpcore.plugin.stages.DeclarativeVersion`. See that class for example usage. | |||
mdellweg
force-pushed
the
stages_doc
branch
2 times, most recently
from
1c9b94d
to
aa2f44d
Compare
asmacdo
approved these changes
Feb 12, 2019
|
@jortel, we aren't removing the second RemoveFuture anymore, so merging now. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[noissue]