docs: Explain bear kinds about documentation HOT 8 CLOSED

From @AbdealiJK on February 22, 2016 12:32

We currently have 2 types of bears, this can be seen in coalib.bears.BEAR_KIND - Global and local

We have 2 major python files which talk about them and define them - coalib.bears.LocalBear and coalib.bears.GlobalBear.

What we need to do is add more information about global and local bears in the documentation.
This can be done in the following locations:

• docs/Users/Tutorials/Tutorial.rst - We never mention that there are two types here. We should atleast mention them and give a 1 line description about them
• docs/Users/Tutorials/Writing_bears.rst - We use localBear without telling what it is. We don't even mention that a global bears exist. We should add an example with a Global bear here.

from documentation.

From @souravsingh on February 23, 2016 9:55

I would like to work on the issue.

from documentation.

From @AbdealiJK on February 23, 2016 9:56

Awesome, @sils1297 can you add @souravsingh to the org so we can assign this issue appropriately ?

from documentation.

From @sils1297 on February 23, 2016 10:46

Invitation is out, accept at github.com/coala-analyzer

2016-02-23 10:56 GMT+01:00 AbdealiJK [email protected]:

Awesome, @sils1297 https://github.com/sils1297 can you add @souravsingh
https://github.com/souravsingh to the org so we can assign this issue
appropriately ?

—
Reply to this email directly or view it on GitHub
coala/coala#1630 (comment)
.

from documentation.

From @souravsingh on February 23, 2016 13:28

I have accepted the invite

from documentation.

From @sils1297 on February 23, 2016 13:29

@souravsingh awesome! If you need help you can approach us on https://gitter.im/coala-analyzer/coala or ask concrete questions here :)

from documentation.

Hey @souravsingh . It seems its been a few days since you have last answered our reviews. Do you need some help? Please feel free to ping us on https://gitter.im/coala-analyzer/coala, as @sils1297 said, or ask here! Id love to help.

from documentation.

unassigned due to inactivity.

from documentation.