DOC: Fix quotes position in pandas.core #24071
Comments
datapythonista
added
Docs
Code Style
|
Hi @datapythonista Can I work on this issue? |
|
Absolutely, let me know if you need help. Thanks @giantpanpan |
|
@datapythonista Thank you! |
|
Hi @datapythonista I have one question is that when I was reading the contributing instruction, it ask us to install the dependencies using the following command. However, I found that the file "ci/environment-dev.yaml" and "ci/requirements-optional-conda.txt" no longer exist in the ./ci dir.
|
|
We updated that document, but you're checking the documentation of the last stable release (which makes sense, but in this case is outdated). Once you have conda set up, from the pandas project root, you need to simply run |
|
@datapythonista I see! Thanks! |
|
this is the latest version of the contributing page: https://pandas-docs.github.io/pandas-docs-travis/contributing.html |
|
@datapythonista is it okay if I pick up this issue? |
|
@giantpanpan is already working on it. Can you look for an issue that nobody mentioned in the comments that is working on it, or that did it more than 2 weeks ago, but didn't finally work on it? If you don't find anything, let me know, I'll open some more "good first issue" |
|
@datapythonista awesome, will do, thanks |
|
@giantpanpan are you still working on this? |
|
@datapythonista Anyone working on it? If no one is working I can work on it. |
|
go ahead, thank you! |
|
Okay. I'm working on it. |
|
It looks like there are bunch of these left. I'm having some difficulty figuring this out: in the case where the doc ends with something touched by Line 4965 in 3855a27 What's the desired outcome on this edge? |
|
This hasn't been active for a couple of months, so what's the status with this issue? Is there still work to be done? |
|
@schimizzimj I think a couple docstrings were overlooked but I've just opened a PR which should close this out. |
|
I am noobie and this looks like an easy tast to start but I would like some guidance maybe there is a noobie instructor that can point in the steps so I can start working on this? I have followed the noobie tutorial on git clone commit status and push I need a specific in this case how to work on this ok so now I have installed all the dependences |
|
Thanks for volunteering @c0dr7 You can take a look at #26037, and continue from there. Check the comments from the review to see what was incomplete, missing or wrong. The general idea is to replace cases like: by: But in some cases the docstrings are generated dynamically and it's trickier. Feel free to send a partial PR with the easy cases, and leave the more complex for a second PR. |
|
@datapythonista I am newbie to open source contribution but not in pandas. I have successfully setup an environment locally using pandas contribution docs. I am not seeing any good first issue on which no one is working. Can you please refer me to some good first issue? Excited to hear from you soon. |
|
Take a look at
https://github.com/pandas-dev/pandas/labels/good%20first%20issue. If
someone said they were going to work on it, but haven't progressed
in a couple weeks and there isn't an open pull request for it, then I think
it's fine for you to work on it.
…On Thu, May 16, 2019 at 4:45 AM Abdur Rehman Nadeem < ***@***.***> wrote:
@datapythonista <https://github.com/datapythonista> I am newbie to open
source contribution but not in pandas. I have successfully setup an
environment locally using pandas contribution docs. I am not seeing any
good first issue on which no one is working. Can you please refer me to
some good first issue? Excited to hear from you soon.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#24071?email_source=notifications&email_token=AAKAOISSG2WGQ6QYNC6HH6LPVUUNHA5CNFSM4GH3G3T2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVRI55I#issuecomment-492998389>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOIU5ZQFL4ZZLZ3VKYZTPVUUNHANCNFSM4GH3G3TQ>
.
|
|
Hey, Newbie, again. I setup the environment and I think I have the latest version. I ran: Output: I'm going to go ahead and correct these and submit a PR for the same. PS: I'm looking for someone to correct me if I'm wrong in submitting my first PR. Thanks. |
To keep out docstrings consistent, and make them easier to read, we try to keep always the same exact format. In the case of the opening and closing quotes, the right format is:
But for historical reasons, we have many docstrings with different format, for example:
Besides being inconsistent, having docstrings with the wrong format doesn't let us start validating and enforcing automatically the wanted format. So, we need to change all the wrong cases.
For this issue, all the wrong cases of methods of
pandas.coreshould be fixed. The list can be obtained with the next command (the command should not report any error when this is fixed):The text was updated successfully, but these errors were encountered: