<commit_before>Frequently Asked Questions
==========================

This is a list of frequently asked questions, aiming to answer any possible
questions by newcomers or even contributors.

What does coala do (for me)?
----------------------------

coala is like a spell and grammar checker for source code. Imagine using
LibreOffice Writer to spellcheck something in English. Why should you have to
write LibreOfficES to check something written in Spanish?
That is what coala  tries to fix. Why write the whole thing again if you
actually just want another analyzing routine? Thats what bears are for. You
want to use clang or pylint on your project? We got you covered. One command
and one configuration to lint all languages in your project.

You have an awesome idea for a new kind of code analysis but don't want to
write a CLI? Write just the parameters your custom analysis needs and the
analysis part, we'll take care of the rest. Everything is handled by coala.

All in all coala does two things:

- Make it easy to use existing static code analyzers by unifying and
  simplifying the configs
- Make it easy to write new routines by offering the interface part
  and everything but the actual analyzer routine.

Can I Use coala in my Continuous Integration?
---------------------------------------------

Yes! There's an argument *--ci* that runs the coala binary in non-interactive
mode, which shows results cleanly in the log and returns error codes
if something goes wrong.

Why did you choose the name?
----------------------------<commit_msg>FAQ.rst: Shorten "What does coala do(for me)?"<commit_after>Frequently Asked Questions
==========================

This is a list of frequently asked questions, aiming to answer any possible
questions by newcomers or even contributors.

What does coala do (for me)?
----------------------------

coala is like a spell and grammar checker for source code. It offers one
command and one configuration to lint all languages in your project.

In short coala does two things:

- Makes it easy to use existing static code analyzers such as clang,
  pylint(and many others) by unifying and simplifying the configs
- Makes it easy to write new routines by offering the interface part and
  everything but the actual analyzer routine. Write just the parameters
  your custom analysis needs and the analysis part, we'll take care of the rest

Can I Use coala in my Continuous Integration?
---------------------------------------------

Yes! There's an argument *--ci* that runs the coala binary in non-interactive
mode, which shows results cleanly in the log and returns error codes
if something goes wrong.

Why did you choose the name?
----------------------------
{'fraction_non_alphanumeric': 0.12122328666175387, 'fraction_numerical': 0.0, 'mean_word_length': 3.046199701937407, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2425995', 'n_tokens_mistral': 654, 'n_tokens_neox': 618, 'n_words': 403}