-
-
Notifications
You must be signed in to change notification settings - Fork 89
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
Improve Rust documentation #186
Labels
Comments
Hi, thanks for testing For now I specified in Contributions are really appreciated! |
yukibtc
changed the title
[nostr_sdk] improve documentation by explaining the internal state of nostr_sdk::Client
Improve Rust documentation
Nov 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the enhancement
there is no explination for what data Client keeps track of or what it does exactly.
namely, the only hint that connect() must be called before relays are added is the example.
Use case
misusing Client will often result in vauge timeout errors or simply empty lists being returned.
functions also don't specify the prerequisites needed before they can be called.
Additional context
the documentation for most functions is just the name of the function without underscores.
it took several days to find out why my program wasn't working, because none of documentation suggests relays won't be automatically connected to as needed.
The text was updated successfully, but these errors were encountered: