Skip to content
This repository has been archived by the owner on Apr 1, 2018. It is now read-only.

capabilities are unclear #30

Closed
sils opened this issue Apr 20, 2016 · 8 comments
Closed

capabilities are unclear #30

sils opened this issue Apr 20, 2016 · 8 comments

Comments

@sils
Copy link
Member

sils commented Apr 20, 2016

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.

from https://news.ycombinator.com/reply?id=11535990&goto=item%3Fid%3D11531718

@sils
Copy link
Member Author

sils commented Apr 20, 2016

@sils
Copy link
Member Author

sils commented Apr 21, 2016

Filed coala/coala-bears#332 about the bear-quality-offensive we have planned but not yet written down for this release.

@Adrianzatreanu
Copy link

Hey where exactly would you want this info about the bears? a gist or something?

@Adrianzatreanu Adrianzatreanu self-assigned this Apr 21, 2016
@sils
Copy link
Member Author

sils commented Apr 21, 2016

I have no idea, ideally coala-bears#332 would be done and then we'd generate a website from that or so :P

Actually yesterday night I thought about this, we can do it right now:

write a little python script that collects all bears and outputs all it's info as markdown, we use that to generate a neat website somewhere and link to that from our website

@Adrianzatreanu
Copy link

i'll do this tonight, i was just gathering info now :) if you want this to be done right away, please assign someone else

@sils
Copy link
Member Author

sils commented Apr 21, 2016

no this is more of a long term thing actually but very important

@sils
Copy link
Member Author

sils commented Aug 4, 2016

this got way better by now with the https://github.com/coala-analyzer/bear-docs

@Adrianzatreanu Adrianzatreanu removed their assignment Sep 25, 2016
@jayvdb
Copy link
Member

jayvdb commented Nov 22, 2017

Closing issue in old repo.

I think https://coala.io/#/languages has mostly covered this, but it is still 'bear'-focused, so coala/landing-frontend#250 covers that problem.

@jayvdb jayvdb closed this as completed Nov 22, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

3 participants