Documentation: Add docs for all the metadata attributes

[Adrianzatreanu]

From @sils1297 on July 24, 2016 12:23

CC @Udayan12167 @Adrianzatreanu

Copied from original issue: coala/coala#2553

[Adrianzatreanu]

From @gitmate-bot on July 24, 2016 12:23

Thanks for reporting this issue! A coalaian will look at it soon.

[Adrianzatreanu]

From @arush0311 on August 12, 2016 19:2

Can you tell me what you mean by metadata attributes and where they can be found?

[Adrianzatreanu]

I think he's referring to the attributes found in https://github.com/coala-analyzer/coala/blob/master/coalib/bears/Bear.py , such as REQUIREMENTS, CAN_DETECT, LICENSE, etc :D

[Adrianzatreanu]

From @arush0311 on August 13, 2016 16:44

Can I take this? I might need some help though.

[Adrianzatreanu]

feel free to, i can help you if needed

[Adrianzatreanu]

This is being moved to https://github.com/coala-analyzer/documentation, please pick it up from there, thank you!

[arush0311]

@Adrianzatreanu Is there anything specific that you want me to add? I think the docs are already present in https://github.com/coala-analyzer/coala/blob/master/coalib/bears/Bear.py from line 46 to 137.

[Adrianzatreanu]

@arush0311 as docs we dont mean docstrings, this repository refers to the docs we have on http://coala.readthedocs.io/en/latest/ , and we probably want a separate page for the metadata attributes? im not really sure. @sils1297 ? @Makman2 ?

[Makman2]

yeah I think we should have something additional. maybe we could add a paragraph here: https://github.com/coala-analyzer/documentation/blob/master/Developers/Writing_Bears.rst

[Adrianzatreanu]

good idea, @Makman2