You mentioned in your proposal that you contributed to the numpydoc validator. Can you reference where that work is? Where is the source for the numpydoc validator?
Aaron Meurer On Tue, Jul 28, 2020 at 2:23 PM Aaron Meurer <asmeu...@gmail.com> wrote: > > Thanks for doing this. Our style guide that was developed last year > differs from numpydoc in a few ways, and it also has some additional > things. But being able to automatically validate those things that can > be validated is good. > > Aaron Meurer > > On Tue, Jul 28, 2020 at 2:18 PM 'Brandon David' via sympy > <sympy@googlegroups.com> wrote: > > > > Hello SymPy mentors! > > > > I apologize that this introduction is coming so late; I was unable to take > > advantage of the "exploration" period and didn't know until just recently > > that applicants are still allowed to contact mentors even after the > > application deadline. I have been hoping to speak with someone about my > > proposal and would love to answer any questions or concerns. Would it be > > possible to do so before the review period ends? > > > > Since submitting my proposal, I have chipped away at its tasks and thought > > it might be helpful to share some of the early results. In preparation for > > converting all docstrings to the numpydoc format, I ran the entire smypy > > library through the numpydoc validator. It took a quite bit of > > monkey-patching to have it not choke on SymPy's docstrings, so the nearly > > 17,000 errors it flagged are just a rough measure of the situation: > > https://gist.github.com/brandondavid/b008667314397b24bbf4f2e6f1fc70ca > > > > I also noticed a few issues that the numpydoc validator didn't, such as > > malformed "See Also" sections and docstrings with repeated section names > > (e.g. crypto.encipher_hill has two "Notes" sections). Still, I think the > > above list is certainly enough to get started and I would be eager to do so > > -- or if you have already settled on a different technical writer, I would > > be happy to supply them with the work I've already done. > > > > Many thanks for your time and I look forward to speaking further! > > > > Cheers, > > Brandon > > > > P.S. If any mentor needs a copy of my proposal, please let me know. I can > > also be reached at brandon.da...@zoho.com > > > > -- > > 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/21d0454c-e1af-4f84-984b-22f0ce4eb29eo%40googlegroups.com. -- 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%3D6KK16atvOhsXL0pyrbNce_zLbxrQN-CLbMbGG1h%3D-Y8QQ%40mail.gmail.com.
