Closed ciriousjoker closed 1 year ago
I also felt the same. It looks like the documentation was written in a block comment.
But darts preferred method is either ///
or /**...*/
.
I think /** */
is just supported to make it compatible with jsdoc, but in reality every package ever uses ///
and the linter will probably scream at you if you try anything else.
I think
/** */
is just supported to make it compatible with jsdoc, but in reality every package ever uses///
and the linter will probably scream at you if you try anything else.
Yes.
@ciriousjoker and @sarankumar-ns , Agree with the above comments and We have updated the API documents accordingly on the latest release. hence closing this issue. Thanks
Example:
What does
retrieveSubscriptions()
do? Why does it take an untypedMap queryParams
instead of actual argument names?Sure, I could look in the readme, but it would be much faster if I could rely on code editor suggestions and inline documentation like with every other package. This also goes beyond just having the untyped map parameter documented. This sdk could easily hide that implementation detail of the underlying native sdks (which imo shouldn't expose this detail either).
There's a reason why this gives you a higher score on pub.dev. It's useful!