GSoC Project: Documentation Extraction and Parsing

[Saurav Singh]

Hi coalians,
Im Saurav Singh, Computer Science and Engineering student from Mumbai. I’m an open-source enthusiast and been an active contributor on coala from past some time. I'm working on a project with coala in GSOC'2017 named as Documentation Extraction & Parsing.
 

• What's this project about?

Well this project is all about developing an analyzing routine at least for python and java that will find all documentation strings in a file, parse them into specific groups and check them against a specified documentation style given by the user.

• How this project is helping coala and it's community?

This project will help coala and its users by having a DocStyleBear, which will help them to adhere with guidelines of writing a formal inline documentation. As the basic idea for DocStyleBear came from PEP-257. So, users of coala can then check their code for the specific formatted docstrings and can even make them correct with ease. A bear base class for Documentation related tasks will be implemented which would take over the extraction, parsing and result (inclusively diff generation). The developers can overrides a function which receives a list of parsed metadata, which can be modified and returned. Further, extending functionality to refine the documentation, a DocGrammarBear will be created which will apply aesthetic (i.e capitalization, sentence termination with a period) and grammar fixes (eg: checking parameter’s description for imperative present tense).

• What is the final goal of this project?

Final goal for this project is to perfect the DocumentationAPI and create DocStyleBear and DocGrammarBear at least for python and java. In which, DocStyleBear will find all documentation strings in a file, parse them into specific groups and check them against a specified documentation style given in PEP-257 and DocGrammarBear will provide a patches that re-formats the documentation correctly, checks for grammatical errors and perform other aesthetical fixes.

• What parts of coala do I have to work with in order to complete this project?

I'll have to work on coala-core and coala-bears repo. Specifically on coala-core I will be refining the DocumentationAPI and with coala-bears repo all the analyzing routines will be integrated in it.

For detailed info, look at my proposal.
Im open for queries and suggestions. Do ping me on gitter channel or reply to this post.
I will be writing continuous blogs every week about my ongoing work at: damngamerz.github.io