Hi there, The current documentation of NumPy is really good but a bit more improvement can be made to it, which is the prime objective of my project. The improvements which I mentioned in my brief proposal are strategies that can be applied to every documentation to make it better.
Apart from general improvements most the documentation related issues in the NumPy's GitHub issue tracker <https://github.com/numpy/numpy/issues?page=2&q=is%3Aissue+is%3Aopen+doc+label%3A%2204+-+Documentation%22> will be addressed. . Some needs more technical information and help from the community. Some are due to the lack of visual aids. Most of them will be addressed and improvements will be made such that similar issues will not be generated in future. Rearranging of sections in the User Guide <https://numpy.org/devdocs/user/absolute_beginners.html> can be done after further discussions Some examples regarding the need of restructuring and duplication are given in the attached document. Apologies in advance if my observations are inaccurate or nitpicks. The given doc is just a very brief one. An in-depth proposal with all the planned changes along with solutions to close as many issues in the tracker will be prepared. I am getting familiar with the community and NumPy. On Thu, Apr 29, 2021 at 9:54 PM Melissa Mendonça <meliss...@gmail.com> wrote: > Hello, Mahesh > > Thank you for your proposal. One thing I would say is that some of the > things you are suggesting are already there - for example, the How-tos and > Explanations section - but I agree they can be improved! > > Another question I could pose is about duplication of content: can you > give examples of duplicated content that you found in the docs? > > Cheers, > > Melissa > > On Wed, Apr 28, 2021 at 12:33 AM Mahesh S <mahesh6947f...@gmail.com> > wrote: > >> Hello, >> >> I am Mahesh from India. I am interested in doing Google Season of Docs >> with NumPy on the project HIGH-LEVEL RESTRUCTURING AND END-USER FOCUS - >> NumPy >> >> I have past experience in documentation writing with WordPress and have >> completed *Google Summer of Code 2018 *with KDE. I have been an open >> source enthusiast and contributor since 2017.My past experience with coding >> ,code documentation , understanding code bases ,will help achieve this task >> without much input from your end. I have about four years experience >> working with Open-Source and currently working as a *Quality >> Assurance specialis*t . I have delivered technical talks at >> international conferences (KDE-Akademy) and was *mentor of Google >> Code-In* also. All these makes me the best candidate for the project. >> >> I am attaching a brief proposal for the work along with this mail. A more >> in-depth A more in depth proposal with timelines , all planned strategies >> , document structures will be submitted after more discussion with the >> mentors and community. >> I am ready to start the work as soon as possible and will be able work 7 >> to 9 hours per day including weekends. I strongly wish to be part of the >> NumPy community even after the project. >> >> >> Hope to hear from you soon >> >> -- >> Thank you >> Mahesh S Nair >> >> _______________________________________________ >> NumPy-Discussion mailing list >> NumPy-Discussion@python.org >> https://mail.python.org/mailman/listinfo/numpy-discussion >> > _______________________________________________ > NumPy-Discussion mailing list > NumPy-Discussion@python.org > https://mail.python.org/mailman/listinfo/numpy-discussion > -- Thank you Mahesh S Nair
Some Examples for improvement.pdf
Description: Adobe PDF document
_______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@python.org https://mail.python.org/mailman/listinfo/numpy-discussion
