Looking to contribute
Hey Guy's I'd like to help out with the python project and have read the documentation on the website. Still a bit unsure as to where to go next but I'd like to take a shot at the following issue: http://bugs.python.org/issue1722 It is my understanding that this is a relatively easy issue to get one's feet wet in the world of contributing. Please be gentle and sorry for any grammatical errors, English is not my first language. Please let me know if you have any tips/comments/suggestions about this issue, or my contribution in general. Kind regards, Sebastiaan.
Hello Sebastiaan, thanks for your offer of contribution! On Fri, Aug 17, 2012 at 2:37 PM, Sebastiaan de Haan <sebastiaan@sebastiaandehaan.nl> wrote:
Hey Guy's
I'd like to help out with the python project and have read the documentation on the website. Still a bit unsure as to where to go next but I'd like to take a shot at the following issue: http://bugs.python.org/issue1722
It is my understanding that this is a relatively easy issue to get one's feet wet in the world of contributing.
Yep it could be the right first step indeed.
Please be gentle and sorry for any grammatical errors, English is not my first language.
Just note that several of us are not native English speakers, but being fluent in English is very useful when dealing with documentation. It doesn't want to discourage you, just a warning. Be sure that there will be native speakers that will correct you in case something is very wrong :)
Please let me know if you have any tips/comments/suggestions about this issue, or my contribution in general.
About that specific issue, take care of the notes where not every function in __all__ should be documented. About contributing, did you read the http://docs.python.org/devguide/ ? There it's written how to checkout the Python source code (that contains documentation too) and prepare patches. Regards, -- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
Hi Sandro, On Sat, Aug 18, 2012 at 10:11 AM, Sandro Tosi <sandro.tosi@gmail.com> wrote:
Hello Sebastiaan, thanks for your offer of contribution!
On Fri, Aug 17, 2012 at 2:37 PM, Sebastiaan de Haan <sebastiaan@sebastiaandehaan.nl> wrote:
Hey Guy's
I'd like to help out with the python project and have read the documentation on the website. Still a bit unsure as to where to go next but I'd like to take a shot at the following issue: http://bugs.python.org/issue1722
It is my understanding that this is a relatively easy issue to get one's feet wet in the world of contributing.
Yep it could be the right first step indeed.
Please be gentle and sorry for any grammatical errors, English is not my first language.
Just note that several of us are not native English speakers, but being fluent in English is very useful when dealing with documentation. It doesn't want to discourage you, just a warning. Be sure that there will be native speakers that will correct you in case something is very wrong :)
Please let me know if you have any tips/comments/suggestions about this issue, or my contribution in general.
About that specific issue, take care of the notes where not every function in __all__ should be documented. About contributing, did you read the http://docs.python.org/devguide/ ? There it's written how to checkout the Python source code (that contains documentation too) and prepare patches.
Yes I have read the information at the link you provided. And have already checked out the source code on my development machine. One question though. If I am done with creating the patch, would it be ok if I post it here for review? Because it's my first time and all.
Regards, -- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
Hi Sebastiaan, On Sat, Aug 18, 2012 at 11:57 AM, Sebastiaan de Haan <sebastiaan@sebastiaandehaan.nl> wrote:
Yes I have read the information at the link you provided. And have already checked out the source code on my development machine.
awesome!
One question though. If I am done with creating the patch, would it be ok if I post it here for review? Because it's my first time and all.
I think it's probably best if you post the patch on the issue directly: the people interested in seeing it fixed are looking at the issue for news, so that would be the place i'd post the patch to. Don't be scared: everyone had their first time submitting a patch to a bug :) Regards, -- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
Hi, On Sat, Aug 18, 2012 at 12:05 PM, Sandro Tosi <sandro.tosi@gmail.com> wrote:
Hi Sebastiaan,
On Sat, Aug 18, 2012 at 11:57 AM, Sebastiaan de Haan <sebastiaan@sebastiaandehaan.nl> wrote:
Yes I have read the information at the link you provided. And have already checked out the source code on my development machine.
awesome!
One question though. If I am done with creating the patch, would it be ok if I post it here for review? Because it's my first time and all.
I think it's probably best if you post the patch on the issue directly: the people interested in seeing it fixed are looking at the issue for news, so that would be the place i'd post the patch to. Don't be scared: everyone had their first time submitting a patch to a bug :)
I am a bit lost. For this particular issue (http://bugs.python.org/issue1722) I have found one of the functions in question in /Lib/urllib/parse.py and the associated documentation file in /Doc/library/urllib.parse.rst But now for the tricky part, how to proceed? The source file function that is missing from the documentation contains a docstring, so... How is the rst file generated and do I just edit the rst file? Or do I go about editing the source file directly? I have tried researching - http://docs.python.org/devguide/documenting.html#documenting - http://docs.python.org/devguide/docquality.html - http://docutils.sourceforge.net/rst.html - http://sphinx.pocoo.org But this has gotten me no further. Is it possible for someone to point me in the right direction... I am sorry if this is a stupid question.
Regards, -- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
Thanks, Sebastiaan.
On Sat, Aug 18, 2012 at 4:58 PM, Sebastiaan de Haan <sebastiaan@sebastiaandehaan.nl> wrote:
I am a bit lost. For this particular issue (http://bugs.python.org/issue1722) I have found one of the functions in question in /Lib/urllib/parse.py and the associated documentation file in /Doc/library/urllib.parse.rst
That's the correct file.
But now for the tricky part, how to proceed? The source file function that is missing from the documentation contains a docstring, so... How is the rst file generated and do I just edit the rst file? Or do I go about editing the source file directly?
You have to change the file Doc/library/urllib.parse.rst with all the changes you want to make, than compile the doc with "make -C Doc html" and then review on the browser the resulting pages. The resulting patch (hg diff) will have to be attached on the issue once all those steps are completed and you're satisfied of the result.
I have tried researching
http://docs.python.org/devguide/documenting.html#documenting http://docs.python.org/devguide/docquality.html http://docutils.sourceforge.net/rst.html http://sphinx.pocoo.org
But this has gotten me no further. Is it possible for someone to point me in the right direction...
I'll review the information in the devguide and integrate them where missing. Regards, -- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
participants (2)
-
Sandro Tosi -
Sebastiaan de Haan