Skip to content

Commit 71c5e48

Browse files
FAQ.rst: Add question "What is a bear anyway?"
This adds a brief description on what a bear is. Closes #284
1 parent dae51e4 commit 71c5e48

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Help/FAQ.rst

+10
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,16 @@ There are also generic bears, which can be applied language independently on
5555
your code. Their capabilities and information can be seen
5656
`here <https://coala.io/#/languages>`__.
5757

58+
What is a bear anyway?
59+
----------------------
60+
61+
A bear is a routine that is used by coala to check your code
62+
for lint issues. A group of these routines(bears) is used for defining
63+
certain quality requirements in various languages. A bear can analyse code
64+
for potential problems, calculate metrics and even provide corrections for
65+
your code. While many of these bears for various languages are shipped along
66+
with coala, you can easily write some of your own.
67+
5868
How do I get started with coala?
5969
--------------------------------
6070

0 commit comments

Comments
 (0)