-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Convert docstring for set_xlim(), per issue #7205 #7369
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.
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
Conversation
That looks good! |
Looking through _axes.py, I see that sometimes True, False, and None are quoted as Is there a preferred style for these things? |
Sorry, this needs a rebase; those call signatures were removed in |
@cfackler We don't have a consensus on this yet. |
Convert set_xlim() docstring to numpydoc format.
Docstrings converted to numpydoc format.
5c16159
to
6ef07e7
Compare
Rebased pull request and also converted set_ylim() docstring. Should I open a new pull request for additional docstring updates to the axes class, or continue to update this one? |
It's pretty much up to you! As long as our documentation builds, I am happy to merge them as they come. But if you prefer to continue working on this PR, I'll be happy to review it once you are done. In general, our docstrings need some love, so don't feel limited to the ones I added on that ticket. If you prefer, you can also work on one of our more complicated ticket, and update the docstrings while you read the code to figure out how to accomplish the tasks in that ticket. |
* DOC adressed reviewer's comments * DOC rdt.org -> rdt.io
This addition is intended to prevent further questions about this on the mailing list: https://mail.python.org/pipermail/matplotlib-users/2016-October/000669.html
Well shoot. I messed up my branch here somehow. |
Did you by any chance rebase something recently? |
Yes, I believe I typed an incorrect rebase. Git was not letting me push my last changes and saying I was behind the remote counterpart. |
There are two options:
The safer is probably the latter, and I can easily walk you through it if you want. |
Ugh, yeah, my commit 6c5a44e was after the rebase. Sounds like the cherry-picking is probably the way to go. Sorry :( and thanks for the help! |
Typing the following sets of commands should work:
And the safest is probably to push into a new branch though you could also update this remote branch by doing:
|
Cool! I've never used cherry-pick before. I now have update-axes-docstrings-fixed as a newly-pushed remote branch. Should I open a new PR based on that branch and close this one? Thanks again for your help! |
Sounds good! This way you'll have a clean start. |
What happened was, you had this:
and pulled new updates:
then rebased:
but GitHub still had the old thing, so when you tried to push, git said "Wait, what happened to B and C? Maybe you forgot them, so you should pull them down." By following git's advice, you pull down the old B and C again, getting:
Then it's a bit unclear to me, but I think another rebase with the original B, C and new B', C' and the new-on-master D, E getting muddled together. |
It's not strictly necessary as you can force push here. In fact, we could do the rebase as well since you've ticked the box on the right allowing it, but that does mean you have to reset your own local copy with these. BTW, when the rebase has got your commits all messed around, it's great to use a GUI like |
@NelleV PR 7389 should be what I had intended for this evening's commit to do. :) @QuLogic That sounds exactly like the rebase I did before commit 6c601c0. But, when I went to push the changes currently committed as 6c5a44e, git complained that I was behind the remote counterpart. That's when I screwed up with a wrong rebase command. |
@QuLogic I'm happy to reset my local copy as needed if you'd like to rebase properly. Thanks for the git GUI tips; I tried to take a look at it in |
Thanks @cfackler ! |
No need, the other PR is already open. You can delete this branch if you want. |
I would like to work on issue #7205.
I have (hopefully) converted the set_xlim() docstring to numpydoc format.
I'd like some feedback, since I've never written a numpydoc-format docstring before. If this change looks good, I'll continue working on the other axes functions.
Thanks!