Google season of docs

Yash Pasari

unread,

May 12, 2020, 1:48:22 AM5/12/20

to sympy

Hi everyone,

As a fan of sympy library and having it used in many of my projects, contributing documentation for this library will be a lot of fun. I am highly motivated to participate for sympy and contribute my part in this year's gsod. I have many ideas regarding improvement of docs by implementing more beginner friendly examples and some mathematical intuition for some methods. I will be discussing my ideas in further posts here.

Hope to connect with you guys and contributing some valuable docs this gsod

Happy contributing!
Yash Pasari

Aaron Meurer

unread,

May 12, 2020, 2:17:16 AM5/12/20

to sympy

Hi Yash.

I'm glad to see your interest. Do you know which modules you would
like to see improved in this way? An example of what you mean by
beginner friendly examples and better mathematical intuition would
also be helpful for us to see the sort of thing you are talking about.

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 view this discussion on the web visit https://groups.google.com/d/msgid/sympy/6e9df446-da6f-4182-a2b0-0ad57c83b3a3%40googlegroups.com.

Yash Pasari

unread,

May 12, 2020, 3:37:25 AM5/12/20

to sympy

Hi Aaron,

Broadly I am speaking of the second idea mentioned in your project ideas with a slight improvement. Many of the physics modules like quantum mechanics, analytical solutions have a little introduction to the topic when compared to mathematical modules. Also since this is a scientific library used for computations, I think the modules must also contain a link to the research text which is used, for better understanding. This would help in making the docs more structured. For many mathematical modules also like in integrals in Laplace transform and various other transformations a link to the research text used would add a great value to the user experience and give a broad mathematical intuition. We can also add some more examples after the basic examples (beginner-friendly) to give an idea of the scope of the method used. There are various other sections in which we can improve the docs for a better structure and user experience.

Regards!

Yash Pasari

On Tuesday, May 12, 2020 at 11:47:16 AM UTC+5:30, Aaron Meurer wrote:

Hi Yash.

I'm glad to see your interest. Do you know which modules you would
like to see improved in this way? An example of what you mean by
beginner friendly examples and better mathematical intuition would
also be helpful for us to see the sort of thing you are talking about.

Aaron Meurer

On Mon, May 11, 2020 at 11:48 PM Yash Pasari <yashpa...@gmail.com> wrote:
>
> Hi everyone,
>
> As a fan of sympy library and having it used in many of my projects, contributing documentation for this library will be a lot of fun. I am highly motivated to participate for sympy and contribute my part in this year's gsod. I have many ideas regarding improvement of docs by implementing more beginner friendly examples and some mathematical intuition for some methods. I will be discussing my ideas in further posts here.
>
> Hope to connect with you guys and contributing some valuable docs this gsod
>
> Happy contributing!
> Yash Pasari
>
> --
> 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 sy...@googlegroups.com.

Nikhil Maan

unread,

May 14, 2020, 5:14:13 PM5/14/20

to sympy

Adding more beginner friendly examples and reference to research text seems like a good idea.
The links can be added to the reference section of the docstrings wherever required.
But, I think a broader set of examples to explain the scope of different methods will be better suited for high-level documentation.

Regards,
Nikhil Maan

Yash Pasari

unread,

May 14, 2020, 5:34:40 PM5/14/20

to sympy

Hi Nikhil,

Great to hear from you!

Yes I also believe that a broader set of examples can be included in high-level documentation and I intend to do that for sympy this gsod. I am also figuring out some more innovative ways to make the documentation more appealing and standardized. Currently, I am going through some common python library docs to get the best from them and implement some good docs for sympy. One thing we could do is to implement a doc page for common errors that users tend to make while using the sympy library or applying functions.