search

coala / documentation

The official documentation for coala
http://docs.coala.io/
GNU Affero General Public License v3.0
39 stars 178 forks source link

Add prominent documentation for coala-ci and coala-json #226

Open SaskiaKeil opened 8 years ago

SaskiaKeil commented 8 years ago

I found no documentation or hint, that you can use coala-ci and coala-json instead of pure coala to get better formatted coala output.

Please add in a suitable place or guide me in the right direction, if it already exists.

sils commented 8 years ago

I think this should go in the tutorial as well as right after installation or so, any other suggestions on wher it should go? We should also put it in the help.

Divya063 commented 7 years ago

I would like to work on this

zhongLxyz commented 7 years ago

In the 'Hint' section of this page, there is a mentioning of using --json to format the output. I am not sure if this is what you are talking about? Also, right above the 'Hint' section, it also mentioned the --ci argument.

But I still feel like this information is a bit hidden being mentioned on this page only. New users may not find this hint on the page. How about putting it in the 'Getting started with Coala' tutorial in a 'see also' box?

Makman2 commented 7 years ago

The coala entrypoints coala-json and coala-format are deprecated in favor of the --json and --format flags.

How about putting it in the 'Getting started with Coala' tutorial in a 'see also' box?

Not sure what's best, but just try it ;)