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. Aaron Meurer On Wed, Jan 18, 2023 at 3:49 PM 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%3D6%2Bps28RA0pzyqPW7nyoJtHFMCs39CZbD7Ca6Z4mz%2B%3DwUA%40mail.gmail.com.
