angular2-jsonapi icon indicating copy to clipboard operation
angular2-jsonapi copied to clipboard

Published 20 hours ago • verified publisher icon ghidoz

Is there API documents available?

Open Liranius opened this issue 7 years ago • 3 comments

Liranius avatar Dec 29 '17 03:12 Liranius

Can you elaborate further on this issue?

HennerM avatar Feb 11 '18 20:02 HennerM

I think it means that there is no documentation at all in the source code (tsdoc, jsdoc).

it's horrible

monkeycatdog avatar Apr 08 '19 16:04 monkeycatdog

@iamruslanbakirov: First of all, feel free to improve the documentation at places, where you think something is missing, misleading, unclear, and then create a pull request. This is an open-source project where people invest there free time to create something - so please respect that.

Second: With the use of typescript a large portion of informative "API documentation" is generated "automatically" by your IDE (e.g. Visual Studio Code). I can see, what signature a method (e.g. createRecord) has, and what types it expects. Most of the times, I don't need to know more.

So the question of @HennerM is valid: what is @Liranius specifically asking for? And since he didn't react in the last 16 months, this "issue" should be closed.

hpawe01 avatar Apr 09 '19 10:04 hpawe01