top | item 11535990

(no title)

xyz198 | 10 years ago

Great effort with the project.

However, I must say that very critical info for first-time users is still unavailable or very vaguely documented. For example, I still have no clue what sort of analysis can be obtained from this page : https://github.com/coala-analyzer/coala-bears/wiki/Available.... I can see a bunch of Bears but that's your terminology. I would rather prefer a brief summary of the tool's analysis or atleast a link to the static analyzer which a specific bear wraps over. For e.g. "AlexBear" - I honestly have no clue what that or 90% of the other bears end up doing with my source code.

You have put so much effort in the implementation, please improve clarity/coverage of documentation.

Also, installation (pip3 install coala-bears) fails on OSX. Any ideas on how to fix that ? Here is the error message : http://pastebin.com/tP3dZsik

Thank you.

discuss

order

sils|10 years ago

So ATM the only way to get more info about a bear is by querying coala for it: `coala -B -b=AlexBear`

We have a project in planning stage to make a browsable webpage generated from the per bear documentation, we will also look a lot at the configurability and documentation of the individual bears for the next release.

sils|10 years ago

Hey, upgrading pip should solve your issue.

I filed an issue for the missing info at https://github.com/coala-analyzer/website/issues/30 , thank you for your feedback!

xyz198|10 years ago

Thanks a lot for incorporating the feedback. I have been working on a similar, internal tool within my company and I have realized the hard way how all capabilities can go waste if not communicated correctly to the stakeholders (developers in this case).

I look forward to contributing to coala if I end up incorporating it alongside my (internal) tool and would like an unimplemented functionality. Good luck.