Document bear API

[Adrianzatreanu]

From @sils1297 on June 4, 2016 16:20

Copied from original issue: coala/coala#2276

[Adrianzatreanu]

From @gitmate-bot on June 4, 2016 16:20

Thanks for reporting this issue!

Your aid is required, fellow coalaian. Help us triage and solving this issue!

CC @sils1297, @AbdealiJK

[Adrianzatreanu]

From @abhsag24 on June 5, 2016 7:37

@sils1297 you mean the bear class?

[Adrianzatreanu]

it's unclear to me either, what exactly do you want to be documented?

[Adrianzatreanu]

From @sils1297 on June 17, 2016 8:42

The API a bear writer can use to create a bear

[Adrianzatreanu]

So you basically want a website on readthedocs where one could specify all the methods for the class which he has available and how he should write that bear?

[Adrianzatreanu]

From @abhsag24 on June 17, 2016 14:0

so we should have tutorials for Diff and SourceRange too right?

[Adrianzatreanu]

From @sils1297 on June 17, 2016 14:2

Currently if you want to write a bear, you have to go through the tutorial
which is not always what you want, sometimes you want a quick API reference
and work out your own stuff

[meetmangukiya]

I guess this has been done now 🤔 with api.coala.io ?

[sils]

we have to check if the current doc is sufficient and link to it

[Mixih]

This issue was moved to coala/coala#3146