This repository was archived by the owner on Oct 10, 2020. It is now read-only.
syscontainers: Add code documentation#1081
Closed
ashcrow wants to merge 1 commit intoprojectatomic:masterfrom
Closed
syscontainers: Add code documentation#1081ashcrow wants to merge 1 commit intoprojectatomic:masterfrom
ashcrow wants to merge 1 commit intoprojectatomic:masterfrom
Conversation
Contributor
Author
|
cc @giuseppe |
giuseppe
reviewed
Aug 25, 2017
Collaborator
giuseppe
left a comment
giuseppe
left a comment
There was a problem hiding this comment.
very useful! Just a small typo and I think it is ready to go
Atomic/syscontainers.py
Outdated
|
|
||
| def version(self, image): | ||
| """ | ||
| Returns information on provided image in ostre. Same as foo = [inspect_system_image(image)]. |
giuseppe
reviewed
Aug 25, 2017
Atomic/syscontainers.py
Outdated
| :param image: Name of the image to pull. If not provided self.args.image is used. | ||
| :type image: str or None | ||
| """ | ||
| # TODO: guard against image and self.args.image being None? |
Collaborator
There was a problem hiding this comment.
apparently tests fail if this line is added
Contributor
Author
There was a problem hiding this comment.
Bah. It's because TODO is considered bad by the checks. I'll remove it.
ashcrow
force-pushed
the
code-doc-syscontainers
branch
from
e608135 to
d3d3f55
Compare
ashcrow
force-pushed
the
code-doc-syscontainers
branch
from
d3d3f55 to
f188aff
Compare
Collaborator
|
☀️ Test successful - status-redhatci |
eyusupov
pushed a commit
to eyusupov/atomic
that referenced
this pull request
Mar 10, 2018
Closes: projectatomic#1081 Approved by: giuseppe
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Description
Adds docstrings and parameter information to the public methods in syscontainers.py. Added as a way to get more comfortable with the module and hopefully help others get up to speed quicker.
Related Bugzillas
None
Related Issue Numbers
None
Pull Request Checklist:
Not needed