docstring added #6123

Merged
merged 4 commits into from Mar 13, 2016

Conversation

Projects
None yet
4 participants
Contributor

ryanbelt 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)
"""
@ryanbelt ryanbelt docstring added
d86e805

mdboom added the needs_review label Mar 7, 2016

Member

QuLogic commented Mar 7, 2016

Please be sure to write clear commit messages.

docstring added to what?

@tacaswell tacaswell commented on an outdated diff Mar 7, 2016

lib/matplotlib/table.py
+ Args:
@tacaswell

tacaswell Mar 7, 2016

Owner

Can you please use the numpydoc formating?

@tacaswell tacaswell commented on the diff Mar 7, 2016

lib/matplotlib/table.py
+ 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)
@tacaswell

tacaswell Mar 7, 2016

Owner

What is the meaning of these integers?

tacaswell added this to the 2.1 (next point release) milestone Mar 7, 2016

@ryanbelt ryanbelt auto_set_column_width docstring with example given
92ccded
Contributor

ryanbelt commented Mar 7, 2016

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

Thank you.

ryanbelt added some commits Mar 7, 2016

@ryanbelt ryanbelt docstring pep8 fixed
a5307d1
@ryanbelt ryanbelt unknown CI server failure. compare to d86e805
893bfea
Contributor

ryanbelt 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

Owner

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.

Owner

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 tacaswell added a commit that referenced this pull request Mar 13, 2016

@tacaswell tacaswell Merge pull request #6123 from ryanbelt/master
DOC: docstring added
62d40ab

@tacaswell tacaswell merged commit 62d40ab into matplotlib:master Mar 13, 2016

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

tacaswell removed the needs_review label Mar 13, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment