Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add jsdoc for BrowserMicroSentryClient class methods #15

Open
alxpsr opened this issue Dec 29, 2023 · 1 comment
Open

[FEATURE] Add jsdoc for BrowserMicroSentryClient class methods #15

alxpsr opened this issue Dec 29, 2023 · 1 comment
Assignees

Comments

@alxpsr
Copy link

alxpsr commented Dec 29, 2023

Docs improvements

Is your feature request related to a problem?

Tried to figure out purposes of all methods inside library classes and it was not obvious and quite difficult without calling them.
It's gonna be very helpful if you can add js-doc for each methods and props

Describe the solution you'd like

Add js-doc for methods

Additional context

Anyway highly appreciate your efforts to develop such library. Thank you guys

@alxpsr alxpsr changed the title [FEATURE] Add jsdoc for BrowserMicroSentryClient methods [FEATURE] Add jsdoc for BrowserMicroSentryClient class methods Dec 29, 2023
@sevaru
Copy link
Contributor

sevaru commented Dec 29, 2023

We are planning to improve our documentation (probably next year).
As you suggest, we will also consider adding more inline documentation.

Thank you for your feedback!

@sevaru sevaru assigned sevaru and unassigned MarsiBarsi Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants