Regarding participation in Google Season of Docs

[Praduman Goyal]

Hello,

I am Praduman Goyal, a junior year student pursuing Applied Mathematics at IIT Roorkee, India. I want to apply for GSoD'19 under sympy. I went through your idea and found myself interested in the idea Consistency across docstrings. I have a good experience with python and writing documentation. My documentation work can be found at https://omniport.readthedocs.io/en/latest/ or https://github.com/IMGIITRoorkee/omniport-docs. I have also a good experience with python, git and other web-technologies.

Please guide me and assign me an issue to work upon so that I can get familiar with the codebase and the project.

Regards,

Praduman Goyal

[Aaron Meurer]

Hi Praduman.

That's great. I would suggest finding a function or small submodule
that you can improve the documentation for. The coverage doctest
script mentioned on the ideas page can help with this.

You should also familiarize yourself with the issues in the idea pages
that are listed for the docstrings idea (I also just added another
issue there that I noticed was missing). That's good that you have
Python experience, as this project may require some Python work to
update the Sphinx (for instance, switching to napoleon).

Aaron Meurer

> --
> You received this message because you are subscribed to the Google Groups "sympy" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
> To post to this group, send email to sy...@googlegroups.com.
> Visit this group at https://groups.google.com/group/sympy.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/0c082797-9ae9-4ab0-9121-89404e5a83d1%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

[Praduman Goyal]

Thanks a lot for your reply.

I have asked for claiming an issue and will respond to it soon.

Regards,

Praduman Goyal

ᐧ

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6K%2B_zwHgqFzxkUD1Z5caFYV4DE_4%2BaW-uA60unKnstMmw%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

--

Regards
Praduman Goyal

Applied Mathematics(II-Year)

+91-89308-15928

[Praduman Goyal]

Hello Aron,

I tried to reach out to you on gitter but was unable to get a response from you. Here is my query 

"I was assigned the issue to fix documentation on plot.py. I was trying to resolve it but having trouble in the same as an initialization, the reason being a little complex structure of the file and the file being ~2200 lines long. Can you please assign me an easy-to-start issue that can help me start to work along?"

Regards,
Praduman Goyal

ᐧ

[Aaron Meurer]

I would suggest finding a smaller file, or only looking at specific functions within that file for now. You may need to browse through the codebase a bit to find a good candidate file to start with. As I noted, the ./bin/coverage_doctest.py script in the repo will list every doctest that is missing a doctest, which could be a good place to start.

Aaron Meurer

To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKd4y-HRfu4y-n52-OdAJzYv6UKmK%3DXc6CrJ81%2B0zUaRQwoS1w%40mail.gmail.com.