carbon-io / carbond

MIT License
2 stars 5 forks source link

Document doStart #241

Open BenElgar opened 6 years ago

BenElgar commented 6 years ago

As far as I can see there are only two places in the docs where doStart is mentioned:

https://github.com/carbon-io/carbond/blob/7be0f60c57a5e9e15a46da7f5da2c09ffbe6115b/docs/code-frags/standalone-examples/TooBusyLimiterExample.js#L26

https://github.com/carbon-io/carbond/blob/57c8f45b45bfb5cc5a0f4bab868cca5994a0ad0d/docs/ref/carbond.Service.rst#methods

It would be nice to have more than that. Would also be good to know where it is available. Does it work on a collection? What about an endpoint?

BenElgar commented 6 years ago

Also it would be nice to know at what point it's called. Is the service initialised? Do I have access to the database? What about the endpoints defined in the service?