[sympy] Re: Google Season of Docs

The SymPy docs are quite fine but I feel most of the modules could use a lot more comments(in-line and block, existing docstrings are already quite good !) It would make it easier for contributors(especially new ones) to fix bugs if there were comments explaining the underlying algorithm/math.

[sympy] Re: Google Season of Docs

It's a little close to the deadline (about 20 minutes), but I am trying to get an application in for GSoD. If anyone is interested in mentoring, please fill out this form https://forms.gle/a1x26WQGzURLerv66. You may need to do it within the next 20 minutes. Aaron Meurer On Wed, Mar 13, 2019 at 1

[sympy] Re: Google Season of docs

Hi Shalini, Glad to know you would like to work with us this GSoD. Have you checked our ideas page? You can find it at https://github.com/sympy/sympy/wiki/GSoD-2020-Ideas. Do you have a preferred idea you would like to work on? Regards, Nik

[sympy] Re: Google Season Of Docs.

Hii Priyanshu Shubham, Have you gone through sympy documentation ? On Monday, June 1, 2020 at 3:06:47 PM UTC+5:30, Priyanshu Shubham wrote: > > Hi everyone, > > As a massive fan of Sympy, I would love to have the opportunity to work >

[sympy] Re: Google Season Of Docs.

Yeah, I have gone through it. -- 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+unsubscr...@googlegroups.com. To view this discussion on the web visit https://grou

[sympy] Re: Google Season of Docs

For anyone interested in applying, please email me (asmeu...@gmail.com) with a resume/CV, a writing sample, and a paragraph describing how you will implement the documentation organization project for SymPy. There is no formal mentoring process with season of docs like there is with summer of code

[sympy] Re: Google Season of Docs

I have mailed to the provided mail ID with the required details, my experience, my works and my CV for the technical writer position in sympy. On Saturday, April 17, 2021 at 1:05:19 AM UTC+5:30 asme...@gmail.com wrote: > SymPy is participating in Google Season of Docs this year. > https://devel

[sympy] Re: Google Season of Docs

Thanks all, Am Joannah, a Cpython core developer and PHD student doing research on Python and garbage collection. I have a hidden goal of learning more about SymPy as I work with the community on reorganizing the docs starting this summer. Best, Joannah On Friday, May 14, 2021 at 4:48:53 PM U

Re: [sympy] Re: Google Season of Docs

> Should SymPy apply? Yes! I'm willing to help with that (likely). Jason moorepants.info +01 530-601-9791 On Wed, Mar 13, 2019 at 1:59 PM Arif Ahmed wrote: > The SymPy docs are quite fine but I feel most of the modules could use a > lot more comments(in-line and block, existing docstrings ar

Re: [sympy] Re: Google Season of Docs

Thanks Jason. Just to clarify, are you able to help with both the application (due April 23) and the mentoring? I also think we should apply. I read some more on their site. Apparently as part of their pilot, they are only going to have 50 slots, with a max of 2 slots per project (https://develope

Re: [sympy] Re: Google Season of Docs

Potentially both. I will try to read about it this weekend. Jason moorepants.info +01 530-601-9791 On Fri, Mar 15, 2019 at 9:55 AM Aaron Meurer wrote: > Thanks Jason. Just to clarify, are you able to help with both the > application (due April 23) and the mentoring? > > I also think we should

Re: [sympy] Re: Google Season of Docs

Great. Let me know if you want to set up a meeting where we can work on it together. Probably some time after the 2nd so that we know what the application looks like. If anyone else is interested in helping out as well, let me know. Aaron Meurer On Fri, Mar 15, 2019 at 2:49 PM Jason Moore wrote

Re: [sympy] Re: Google Season of Docs

The org applications for Google Season of Docs are now open. https://developers.google.com/season-of-docs/docs/get-started/. The deadline is April 23 which is in about two weeks. Jason, we should schedule a time to work on it. If anyone else is interested in helping let me know. Aaron Meurer

Re: [sympy] Re: Google Season of Docs

Dear Aaron, I would like to help SymPy with GSoD. I love it when someone wants to improve their documentation and readability. I might not be very familiar with SymPy documentation right now. But, the program wil effectively begin in September. By that time, (specially with GSoC), I would get fa

Re: [sympy] Re: Google Season of Docs

Hi Aaron, My name is Mayank Jha and I am a pre-final year B.Tech CSE Student at GGSIPU Delhi. I am also interested in helping SymPy with GSoD. Please help me to get started. Hoping to hear from you soon. Regards Mayank Jha -- You received this message because you are subscribed to the Google Gro

Re: [sympy] Re: Google Season of docs

Hello Great to hear from you. I have looked at your ideas page but am yet to decide one specific idea. I will make some personal notes and get back to you with at most 3 ideas tomorrow. And then I think we can touch base on 1 after discussion. Thanks. On Fri, 15 May 2020 at 2:07 AM, Nikhil Maan w

[sympy] Re: Google Season of Docs 2021

Hii Aaron. I was contributing for 1 month to apply in google season of docs, but in the end, I get to know that the guys who already have experience in technical writing can only use it. Is this rule still there, or are there some modifications in it? Thank you. On Wednesday, February 10, 2021 a

[sympy] Re: Google Season of Docs 2021

Hii Aaron. I was contributing for 1 month to apply in google season of docs last year before its start, but in the end, I get to know that the guys who already have experience in technical writing can only apply. Is this rule still there, or are there some modifications in it? Thank you. On Wedn

[sympy] Re: Google Season of Docs 2021

Google is going to have a webinar to answer questions about the season of docs organization applications https://groups.google.com/g/season-of-docs-announce/c/gFLURLNK1VM/m/LA4NzuN6AgAJ. I am going to try to attend one of the times. If someone has a question they want me to ask, let me know. Aaron

[sympy] Re: Google Season of Docs 2021

I have written up the organization application for Google Season of Docs here https://github.com/sympy/sympy/wiki/GSoD-2021-Organization-Application. I have based it on the idea for improving the organization of documentation. The application template is here https://developers.google.com/season-o

Re: [sympy] Re: Google Season of Docs

To you, how long is the estimated time for this project? On Fri, Apr 16, 2021 at 8:58 PM Aaron Meurer wrote: > For anyone interested in applying, please email me > (asmeu...@gmail.com) with a resume/CV, a writing sample, and a > paragraph describing how you will implement the documentation > org

Re: [sympy] Re: Google Season of Docs

Please everyone, What is the deadline for applying for Google season of Docs??? On Sun, Apr 18, 2021 at 6:06 PM Mhd Ali wrote: > To you, how long is the estimated time for this project? > > On Fri, Apr 16, 2021 at 8:58 PM Aaron Meurer wrote: > >> For anyone interested in applying, please email

Re: [sympy] Re: Google Season of Docs

The timeline for Google Season of Docs can be found at https://developers.google.com/season-of-docs/docs/timeline. The development period runs from May 17 to November 16. Our hiring deadline is May 17, so we would like to receive applications by May 7, so that we have time to review them. Aaron M

[sympy] Re: Google Season of Docs Participants Announced

Hi Sympyers! Thanks for the introduction Jason! I'm very excited to be participating in the inaugural Google Season of Docs with SymPy. I've been working as the technical copy editor for Astropy which has been a great experience all around, so I am delighted to be expanding my network within the o

[sympy] Re: Google Season of Docs organization application

I'm interested in joining the GSoD as a mentor, for some prior experiences in solving the sphinx issues in the community. But I'd have some other questions to clarify what kind of ideas from below are clearly out of scope regarding the comment. Ideas that involve writing code are generally out o

[sympy] Re: Google Season of Docs organization application

I am also interested in mentoring for GSoD. I am pretty familiar with the documentation, and I also have some prior experience as a technical writer, which might be useful during the program. As for the question of scope, the program is meant for technical writers, who might not be too familiar

[sympy] Re: Google Season of Docs organization application

I have also submitted the form to mentor the program. On Tuesday, April 14, 2020 at 5:36:55 AM UTC+9, Aaron Meurer wrote: > > The Google Season of Docs (GSoD) organization applications are now > open. See https://developers.google.com/season-of-docs/docs/admin-guide. > > If anyone is interested

Re: [sympy] Re: Google Season of Docs 2021

This is what the Google page for technical writers says https://developers.google.com/season-of-docs/docs/tech-writer-guide > Do you have technical writing skills and experience? Season of Docs is not intended to teach basic technical writing skills. Are you self-motivated and organized? And also

[sympy] Re: Google Season of Docs 2023 announced

Hello On Thursday, 19 January 2023 at 04:19:44 UTC+5:30 asme...@gmail.com wrote: > Google has announced they are running Google Season of Docs again this > year https://developers.google.com/season-of-docs. The deadline for us to > apply is February 15. > > I'd like to apply again. Before we do

[sympy] Re: Google Season of Docs 2023 announced

On Thursday, 19 January 2023 at 04:19:44 UTC+5:30 asme...@gmail.com wrote: If you are interested in working with us, please reach out. Aaron Meurer Hello Aaron and Sympy community, I am Aman Kumar Shukla, a BE chemical undergrad student at BITS Pilani, Pilani Campus from India. I would like to

[sympy] Re: Google Season of Docs 2023 announced

Ping on this. Our deadline to apply to Season of Docs is March 24, a week from today (the Feb 15 date I wrote above was wrong). If anyone is interested in working with us, please reach out. Also if any SymPy community members are interested in helping out with mentoring for this, let me know. Aar

Re: [sympy] Re: Google Season of Docs Participants Announced

Hi Lauren. We are excited to have you working with us! On Thu, Aug 8, 2019 at 10:18 AM Lauren Glattly wrote: > > Hi Sympyers! > > Thanks for the introduction Jason! I'm very excited to be participating in > the inaugural Google Season of Docs with SymPy. I've been working as the > technical cop

Re: [sympy] Re: Google Season of Docs Participants Announced

Hi, On Thu, Aug 8, 2019 at 6:23 PM Aaron Meurer wrote: > > Hi Lauren. We are excited to have you working with us! > > On Thu, Aug 8, 2019 at 10:18 AM Lauren Glattly > wrote: > > > > Hi Sympyers! > > > > Thanks for the introduction Jason! I'm very excited to be participating in > > the inaugura

Re: [sympy] Re: Google Season of Docs Participants Announced

Thanks for these thoughts so far Aaron and Matthew! It sounds like some of the inconsistencies SymPy is dealing with are somewhat similar to inconsistencies I've been addressing in Astropy's documentation. I'll start compiling these suggestions into a doc so we can refine what my top priorities wil

Re: [sympy] Re: Google Season of Docs Participants Announced

Another thing that will probably come up, related to the mathematical formatting, is to what degree formulas in docstrings should be formatted with LaTeX. Consider something like https://docs.sympy.org/latest/modules/functions/special.html#sympy.functions.special.gamma_functions.uppergamma. The mat

Re: [sympy] Re: Google Season of Docs Participants Announced

I think LaTeX is essential.  Has anyone though of the relationship of docs to Jupyter notebook/lab?  Do you want to be able to launch a notebook from the doc? On 8/9/19 5:33 PM, Aaron Meurer wrote: Another thing that will probably come up, related to the mathematical formatting, is to what deg

Re: [sympy] Re: Google Season of Docs Participants Announced

I one of the advocates of de-emphasizing complex math that requires latex in the docsrings. When I'm programming my primary needs 1) are finding the variable, function, or class that needs to be used and then 2) understanding how to use that object. I am rarely concerned with the mathematical detai

Re: [sympy] Re: Google Season of Docs Participants Announced

On Sat, Aug 10, 2019 at 9:57 AM Jason Moore wrote: > > I one of the advocates of de-emphasizing complex math that requires latex in > the docsrings. When I'm programming my primary needs 1) are finding the > variable, function, or class that needs to be used and then 2) understanding > how to u

Re: [sympy] Re: Google Season of Docs Participants Announced

> If you're arguing against having the mathematical definitions inside the functions No where have I argued for that. Jason moorepants.info +01 530-601-9791 On Sun, Aug 11, 2019 at 10:48 AM Aaron Meurer wrote: > On Sat, Aug 10, 2019 at 9:57 AM Jason Moore wrote: > > > > I one of the advocate

Re: [sympy] Re: Google Season of Docs Participants Announced

On Mon, Aug 12, 2019 at 8:43 AM Jason Moore wrote: > > > If you're arguing against having the mathematical definitions inside the > > functions > > No where have I argued for that. If this isn't what you are suggesting then that's great. It sounded like you were, but I may have misread what you

Re: [sympy] Re: Google Season of Docs Participants Announced

Yes and I moved it to the notes section in the example. I de-emphasized the "complex mathematical expression" written in latex because It is unhelpful in plaintext. Jason moorepants.info +01 530-601-9791 On Mon, Aug 12, 2019 at 7:56 AM Aaron Meurer wrote: > On Mon, Aug 12, 2019 at 8:43 AM Jaso

Re: [sympy] Re: Google Season of Docs Participants Announced

On Mon, Aug 12, 2019, at 9:03 AM, Jason Moore wrote: > Yes and I moved it to the notes section in the example. I de-emphasized > the "complex mathematical expression" written in latex because It is > unhelpful in plaintext. Here is another idea that I had recently, which might be a nice solut

Re: [sympy] Re: Google Season of Docs Participants Announced

The Fungrim form is readable in plaintext, which is a good thing. It is also easier to read a sympy integral than the latex too. Jason moorepants.info +01 530-601-9791 On Mon, Aug 12, 2019 at 3:54 PM Ondřej Čertík wrote: > > > On Mon, Aug 12, 2019, at 9:03 AM, Jason Moore wrote: > > Yes and I

Re: [sympy] Re: Google Season of Docs Participants Announced

A possible middle ground would be to print the definition as a SymPy expression. The docstrings in the ODE module use the ODE module to pretty print the general solution https://docs.sympy.org/latest/modules/solvers/ode.html (unfortunately, using the ASCII pretty printer, we could potentially use U

Re: [sympy] Re: Google Season of Docs Participants Announced

On Mon, Aug 12, 2019, at 7:47 PM, Aaron Meurer wrote: > A possible middle ground would be to print the definition as a SymPy > expression. The docstrings in the ODE module use the ODE module to > pretty print the general solution > https://docs.sympy.org/latest/modules/solvers/ode.html (unfortun

Re: [sympy] Re: Google Season of Docs Participants Announced

On Mon, Aug 12, 2019 at 8:39 PM Ondřej Čertík wrote: > > > > On Mon, Aug 12, 2019, at 7:47 PM, Aaron Meurer wrote: > > A possible middle ground would be to print the definition as a SymPy > > expression. The docstrings in the ODE module use the ODE module to > > pretty print the general solution >

Re: [sympy] Re: Google Season of Docs Participants Announced

On Tuesday, August 13, 2019 at 8:59:23 AM UTC+2, Aaron Meurer wrote: > > On Mon, Aug 12, 2019 at 8:39 PM Ondřej Čertík > wrote: > > > > > > > > On Mon, Aug 12, 2019, at 7:47 PM, Aaron Meurer wrote: > > > A possible middle ground would be to print the definition as a SymPy > > > expression. T

Re: [sympy] Re: Google Season of Docs Participants Announced

Here is another example taken from physics.vector.point. There is a method that calculates an acceleration ( https://github.com/sympy/sympy/blob/master/sympy/physics/vector/point.py#L57). The docstring is currently: """Sets the acceleration of this point with the 1-point theory. T

Re: [sympy] Re: Google Season of Docs Participants Announced

I was thinking more about Aaron's mention of measuring the documentation use and started wondering how to get more and better insight into what is good and bad about our documentation. One issue that this conversation suffers from is that Aaron probably knows more about SymPy that almost anyone. On

Re: [sympy] Re: Google Season of Docs Participants Announced

On Tue, Aug 13, 2019 at 10:49 AM Jason Moore wrote: > > > I don't know that for sure, so maybe there is some way we could measure > > that. > > This is something Lauren could do, a proper survey to solicit feedback on > docstrings/documentation from users would really help. Right now we are just

Re: [sympy] Re: Google Season of Docs Participants Announced

> I like this approach a lot. I agree. It is a nice idea. Jason moorepants.info +01 530-601-9791 On Tue, Aug 13, 2019 at 10:22 AM Ondřej Čertík wrote: > > > On Tue, Aug 13, 2019, at 10:49 AM, Jason Moore wrote: > > > I don't know that for sure, so maybe there is some way we could > measure th

Re: [sympy] Re: Google Season of Docs Participants Announced

On Tue, Aug 13, 2019, at 8:32 AM, Fredrik Johansson wrote: > On Tuesday, August 13, 2019 at 8:59:23 AM UTC+2, Aaron Meurer wrote:On > Mon, Aug 12, 2019 at 8:39 PM Ondřej Čertík wrote: > > > > > > > > > > > > On Mon, Aug 12, 2019, at 7:47 PM, Aaron Meurer wrote: > > > > A possible middle g

Re: [sympy] Re: Google Season of Docs Participants Announced

On Tue, Aug 13, 2019, at 10:49 AM, Jason Moore wrote: > > I don't know that for sure, so maybe there is some way we could measure > > that. > > This is something Lauren could do, a proper survey to solicit feedback > on docstrings/documentation from users would really help. Right now we > ar

Re: [sympy] Re: Google Season of Docs Participants Announced

We can write a Sphinx extension that lets you write .. sympy:: Eq(uppergamma(s, x), Integral(t**(s - 1)*exp(-t), (t, x, oo))) and Sphinx will pass the string through latex(sympify(...)). That way we get the best of both worlds. The downside is that you are much more limited in what you can re

Re: [sympy] Re: Google Season of Docs Participants Announced

> I don't know that for sure, so maybe there is some way we could measure that. This is something Lauren could do, a proper survey to solicit feedback on docstrings/documentation from users would really help. Right now we are just getting info from a few vocal speakers. > Maybe our docstring stan

Re: [sympy] Re: Google Season of Docs Participants Announced

I agree with Jason that a proper survey on how the SymPy documentation is used and by who could be helpful. One of the biggest conversations of Google Season of Docs (and something I'm seeing with other open source software projects) is "who is the audience of our documentation" and "how can it be

Re: [sympy] Re: Google Season of Docs Participants Announced

Lauren, Great summary! Looking forward to what you can do with the info. Jason moorepants.info +01 530-601-9791 On Tue, Aug 13, 2019 at 4:08 PM Lauren Glattly wrote: > I agree with Jason that a proper survey on how the SymPy documentation is > used and by who could be helpful. One of the bigg

Re: [sympy] Re: Google Season of Docs organization application

I would first like to remind everyone that we participated in Google Season of Docs last year. This is the report of the project https://github.com/sympy/sympy/wiki/GSoD-2019-Report-Lauren-Glattly:-SymPy-Documentation-Style-Guide. The technical writer, Lauren Glattly, did not write code. However, s

Re: [sympy] Re: Google Season of Docs organization application

I am working on the organization application for GSoD now. Anyone who is interested in mentoring, please let me know, and also fill out this form https://bit.ly/gsod-mentor-reg. The deadline for the application is Monday. If you are interested in mentoring, please let me know right away so I can

Re: [sympy] Re: Google Season of Docs organization application

Hi Aaron, I have filled out the form and will be happy to mentor for the program. Regards, Nikhil Maan On Saturday, May 2, 2020 at 12:47:02 AM UTC+5:30, Aaron Meurer wrote: > > I am working on the organization application for GSoD now. > > Anyone who is interested in mentoring, please let me k

Re: [sympy] Re: Google Season of Docs organization application

I have the application that I intend to submit here. If you can review it by tomorrow, please do so. The deadline is Monday. https://github.com/sympy/sympy/wiki/GSoD-2020-Organization-Application Aaron Meurer On Sat, May 2, 2020 at 5:57 PM S.Y. Lee wrote: > > I have also submitted the form to me

[sympy] Re: Google Season of Docs applications are open

Hi! I'm currently a Masters student in Physics. I've been wanting to contribute to SymPy through GSoC for a while, but due to course load, I've not managed to do so. GSoD offers me an opportunity to contribute. I'm currently in the process of writing my Master's Thesis. That is the extent of my

Re: [sympy] Re: Google Season of Docs applications are open

Hi Prajwal. Sorry for not responding sooner to this. I would still encourage you to apply. It is true that we would prefer applicants that have direct technical writing experience, but indirect experience with writing is useful as well. If you can include examples in your application that show you

Re: [sympy] Re: Google Season of Docs applications are open

Hi everyone, Just a reminder that the deadline for Google Season of Docs writer application *is July 9, 2020, at 18:00 UTC, *which is in about 3 days. If anyone is interested in applying for GSoD this season, please make sure you complete your application before the deadline. Also, whoeve