Re: [sympy] Google Season of Docs 2020 Proposal

2020-07-29 Thread Aaron Meurer
Thanks for the writeup. I agree with you about tooling. For documentation in particular, over use of tooling can lead to a situation where documentation is written more for machines than humans. Consistency in formatting is important and certainly makes it easier for humans to read documentation, b

Re: [sympy] Google Season of Docs 2020 Proposal

2020-07-29 Thread 'Brandon David' via sympy
The numpydoc validator is available at https://github.com/numpy/numpydoc/blob/master/numpydoc/validate.py and can be run with python -m numpydoc --validate However, it has some limitations out-of-the-box, e.g. it does not offer package-wide validation or any form of .rst parsing. Rather, it acc

Re: [sympy] Google Season of Docs 2020 Proposal

2020-07-28 Thread Aaron Meurer
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 wrote: > > Thanks for doing this. Our style guide that was developed last

Re: [sympy] Google Season of Docs 2020 Proposal

2020-07-28 Thread Aaron Meurer
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 sy

[sympy] Google Season of Docs 2020 Proposal

2020-07-28 Thread 'Brandon David' via sympy
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 so