Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Update #100

Closed
wants to merge 6 commits into from
Closed

Documentation Update #100

wants to merge 6 commits into from

Conversation

cevich
Copy link
Member

@cevich cevich commented Apr 24, 2014

No description provided.

@cevich cevich added this to the Dockertest API Version 0.7.1 milestone Apr 24, 2014
@cevich cevich self-assigned this Apr 24, 2014
@cevich
Copy link
Member Author

cevich commented Apr 24, 2014

From #99 (comment)

@Lorquas @jzupka @ldoktor Just send your module commits as squash! commits in pull-requests to my branch: https://github.com/cevich/autotest-docker/tree/init_param_doc_fix that way I can make sure to include your sign-offs. Thanks.

i.e.
git commit -asm "squash! documentation: Move __init__ docstrings to classes"

@cevich cevich mentioned this pull request Apr 24, 2014
Closed
@cevich
Copy link
Member Author

cevich commented Apr 29, 2014

@jzupka @Lorquas How are you doing on updates to the files I gave you to update? It shouldn't take more than 5-minutes, and I'd really like to include this update in 0.7.1. Here's my comment from the other issue:

@Lorquas would you mind looking into #1 and #2 above (and any additional ideas you have) for the dockercmd module?

@jzupka Could you help fix the same documentation (#1) problem in the images and container modules?

@cevich
Copy link
Member Author

cevich commented Apr 30, 2014

@jzupka Okay, just need your updates to this. It's super easy, 15-minutes or less: Cut-paste init docstring parameter docs into the class-level docstring.

@cevich
documentation: Move __init__ docstrings to classes
9a49580 
*  Documentation renders by default with class
   init. params. in headline.  Since special
   methods are also generally hidden, it reads
   better if all init param docs are put in
   class-level docstring.

*  Commitments have been made to continuing this project
   officially, so removed warning message from beginning
   of docs and index.

Signed-off-by: Chris Evich <cevich@redhat.com>
Signed-off-by: Lukáš Doktor <ldoktor@redhat.com>
Signed-off-by: James Molet <jmolet@redhat.com>
@cevich
dockercmd: Raise Except. if subargs is a string
a6e011f 
Signed-off-by: James Molet <jmolet@redhat.com>
@cevich
dockertest: Mass-docstring + pep8 fix/cleanup
9198e61 
Signed-off-by: Chris Evich <cevich@redhat.com>
@cevich
dockertest: Minor cleanups
c3c4a83 
*  Fully deprecated OutputGoodBase.output_good and
   updated unittests.

*  Officially declared environment.AllGoodBase.__init__
   as abstract.

*  Removed unnecessary TODO comment

Signed-off-by: Chris Evich <cevich@redhat.com>
@jzupka
Copy link
Contributor

jzupka commented May 2, 2014

@cevich I could :-D

Jiří Župka added 2 commits May 2, 2014 12:17
containers: Fix __init__ docstrings.
e75a20b 
Signed-off-by: Jiří Župka <jzupka@redhat.com>
images: Fix __init__ docstrings.
88eedd5 
Signed-off-by: Jiří Župka <jzupka@redhat.com>
@cevich
Copy link
Member Author

cevich commented May 2, 2014

pretty p-p-p-p-p-p-pleeeeease @jzupka 😀

@cevich
Copy link
Member Author

cevich commented May 2, 2014

Okay, thanks everone, this is now fixed in: #88

@cevich cevich closed this May 2, 2014
@cevich cevich deleted the init_param_doc_fix branch September 5, 2014 15:58
@cevich cevich restored the init_param_doc_fix branch September 5, 2014 15:58
@cevich cevich deleted the init_param_doc_fix branch October 28, 2014 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@cevich cevich

Labels
Docker Autotest Feature On Milestone
Projects
None yet
Milestone
Dockertest API Version 0.7.1
Development

Successfully merging this pull request may close these issues.
2 participants
@cevich @jzupka