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

expand api documentation #340

Closed
1 task
BananaAcid opened this issue Feb 22, 2023 · 2 comments · Fixed by #595
Closed
1 task

expand api documentation #340

BananaAcid opened this issue Feb 22, 2023 · 2 comments · Fixed by #595
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BananaAcid
Copy link

BananaAcid commented Feb 22, 2023

Describe the feature

Please describe what each function does and is meant to be used for (and ideally an example), in the api documentation.

  1. As well as when context is filled / how long it is persistent.

  2. useSession - data does not seem to be persistent, please add a note how this could be changed (a usage example)

... having to read the source files to get a clue on what a function does, because the documentation does not contain an explanation seems to me to be very cumbersome.

Additional information

  • Would you be willing to help implement this feature?
@pi0
Copy link
Member

pi0 commented Feb 24, 2023

We are working with @manniL to add more detailed docs both as guide and better API docs in jsdocs/readme.

@pi0 pi0 added the documentation Improvements or additions to documentation label Feb 24, 2023
@TheAlexLichter TheAlexLichter self-assigned this Feb 24, 2023
@Barbapapazes
Copy link
Member

related to #595

Hello @BananaAcid, do not hesitate to provide some feedbacks on the PR!

@Barbapapazes Barbapapazes mentioned this issue Jan 28, 2024
1 task
@pi0 pi0 closed this as completed in #595 Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants