Skip to content

docstring added#6123

Merged
tacaswell merged 4 commits intomatplotlib:masterfrom
mercurynomercy:master
Mar 13, 2016
Merged

docstring added#6123
tacaswell merged 4 commits intomatplotlib:masterfrom
mercurynomercy:master

Conversation

@mercurynomercy
Copy link
Copy Markdown
Contributor

@mercurynomercy mercurynomercy commented Mar 7, 2016

Table: auto_set_column_width not working #6047

doc string has added.
method description

""" Given column indexs in either List, Tuple or int. Will be able to
       automatically set the columns into optimal sizes.

method example

Args:
    col(List): list of indexs
    >>>table.auto_set_column_width([-1,0,1])

    col(Tuple): tuple of indexs
    >>>table.auto_set_column_width((-1,0,1))

    col(int): index integer
    >>>table.auto_set_column_width(-1)
    >>>table.auto_set_column_width(0)
    >>>table.auto_set_column_width(1)
"""

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Mar 7, 2016

Please be sure to write clear commit messages.

docstring added to what?

tacaswell
tacaswell reviewed Mar 7, 2016
View reviewed changes
lib/matplotlib/table.py
""" Given column indexs in either List, Tuple or int. Will be able to
automatically set the columns into optimal sizes.

Args:
Copy link
Copy Markdown
Member

@tacaswell tacaswell Mar 7, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please use the numpydoc formating?

@tacaswell tacaswell added this to the 2.1 (next point release) milestone Mar 7, 2016
@mercurynomercy
Copy link
Copy Markdown
Contributor Author

mercurynomercy commented Mar 7, 2016

I have added the detail explaination on what is the -1,0,1 meaning for before the example.

Thank you.

@mercurynomercy
Copy link
Copy Markdown
Contributor Author

mercurynomercy commented Mar 8, 2016

unknown CI server failure. compare to d86e805. I have nothing change on the code excepted the docstring pep8. even on 92ccded, all test cases are passed except pep8.

I need some help on this. Any comment on this?

Thank you

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Mar 8, 2016

We have a couple of transient test failures that have not been tracked down and squashed yet. When we went to 0 tolerance on a majority of the test images we got most of them but it exposed some others.

@tacaswell
Copy link
Copy Markdown
Member

tacaswell commented Mar 13, 2016

Merging as is.

It would be better if it followed the https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt format, but anything is better than nothing.

tacaswell added a commit that referenced this pull request Mar 13, 2016
@tacaswell
Merge pull request #6123 from ryanbelt/master
62d40ab 
DOC: docstring added
@tacaswell tacaswell merged commit 62d40ab into matplotlib:master Mar 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v2.1

Development

Successfully merging this pull request may close these issues.

4 participants

@mercurynomercy @QuLogic @tacaswell @mdboom