On Wed, Jan 18, 2023 at 8:43 PM 'Anurag Surendra Bhat (B20CS097)' via sympy <sympy@googlegroups.com> wrote:
> Hello Aaron and Sympy community, > I am Anurag Bhat, a computer science student at Indian Institute of > Technology Jodhpur. I have been contributing to SymPy for the past year and > had proposed for GSOC'22 with Sympy also. More about my work can be found > here <https://github.com/sympy/sympy/issues?q=author:faze-geek+is:open>. > This is to say that I have a fair idea of how Sympy works and have gone > through multiple modules. > Improving reference docstring documentation is something I wanted to > discuss and work upon since last year but didn't know if SymPy needed that > or if there were any relevant issues open regarding this. I believe I would > be interested if this is available as a project. > > Some of the pointers I can think of at the top of my head along with those > you have mentioned are - > > 1. Docstrings of various modules have been written differently, following > different styles of documentation,different spacing and different > conventions. Although this looks consistent within the file , it leads to > inconsistency throughout the codebase. > > For example (a recently fixed case I remember) - > This style in *stats* module for parameters - > > > *-- a symbol-- a PDF in terms of indexed symbols of the symbol given as > the first argument* > > In many other modules it would have been written like this - > > > > > > * Parameters ========== symbol : Symbol Represents name of > the random variable. pdf : A PDF in terms of indexed symbols of the > symbol given * > * as the first argument* > This is the sort of thing that's spelled out in the style guide https://docs.sympy.org/latest/contributing/docstring.html#parameters-section. But it isn't followed everywhere. Aaron Meurer > > 2. At some instances, docstrings are not written accurately or are > partially correct with reference to Wikipedia(or other online references). > For examples look at this pr <https://github.com/sympy/sympy/pull/22969> where > a half complete docstring needed to be corrected since it led to confusion. > > 3. Grammatical mistakes in the docstring are common and need to be > corrected. > > > If this project is proposed and offered I would surely like to be a part > of it and discuss it in greater detail. Kindly keep me in mind if this pops > up in the near future. > > Regards, > Anurag Bhat. > IIT Jodhpur (2020-24) > > > On Thu, Jan 19, 2023 at 4:19 AM Aaron Meurer <asmeu...@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 that, though, we need to come up >> with a project idea. I'd also ideally like to find someone to hire before >> then too (unlike Google Summer of Code, Season of Docs works like a grant >> program. We apply for money from Google and if we are accepted they pay us >> and we hire someone). If you are interested in working with us, please >> reach out. >> >> This year, I'd like to focus on improving the overall quality of our >> reference "docstring" documentation. I'm open to other ideas, but I >> personally see this as the biggest deficiency in our documentation right >> now. The quality of our reference documentation varies from good to OK to >> bad to nonexistent. We have a documentation style guide that was written as >> part of a previous season of docs, but it is not followed everywhere >> https://docs.sympy.org/latest/contributing/documentation-style-guide.html >> . >> >> This project mostly would consist of various small cleanups to the >> existing documentation. For example: >> >> - There are also various little issues that are prevalent in the >> reference docs. For example, the misuse of single backticks, which >> currently create LaTeX, instead of double backticks (see >> https://github.com/sympy/sympy/issues/13519). >> >> - There's a lot of various grammatical errors in the docstrings. >> >> - There are a lot of functions that have docstrings but which aren't >> included in Sphinx, and would require little RST cleanups to include. >> >> These sorts of cleanups are not hard, but the issue is that we have a lot >> of documentation, so they will take a dedicated effort to do. >> >> 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+unsubscr...@googlegroups.com. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/sympy/CAKgW%3D6JiL_MbCKVS-Mpb4r2GdjR_vTQv1-m4qCgmS%2BtypdY9PA%40mail.gmail.com >> <https://groups.google.com/d/msgid/sympy/CAKgW%3D6JiL_MbCKVS-Mpb4r2GdjR_vTQv1-m4qCgmS%2BtypdY9PA%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> > -- > 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://groups.google.com/d/msgid/sympy/CAOqN0PO16jTOqdMRKakxc26KTrannQTRSr%2BraJRRtPwksVnPAA%40mail.gmail.com > <https://groups.google.com/d/msgid/sympy/CAOqN0PO16jTOqdMRKakxc26KTrannQTRSr%2BraJRRtPwksVnPAA%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > -- 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://groups.google.com/d/msgid/sympy/CAKgW%3D6J3aSm%2B%3DJakqx8j8tfpDnwqJSfN36HBgT_VKNBAhPtUEg%40mail.gmail.com.
