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

Document listen websocket api #91

Open
jcdyer opened this issue Aug 22, 2024 · 0 comments
Open

Document listen websocket api #91

jcdyer opened this issue Aug 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jcdyer
Copy link
Contributor

jcdyer commented Aug 22, 2024

  • Add documentation to each of the public types and methods in src/listen/websocket.rs including example code snippets and links to deepgram documentation. (See src/listen/rest.rs
  • Remove the #![allow(missing_docs)] annotation from the top of that file.

Notes:

  • See https://docs.rs/deepgram/latest/deepgram/listen/websocket/index.html for the current rendering of that module's docs.
  • Run cargo doc --open to generate a local copy of the docs, and open them in your default browser.
  • Consider pushing a patch-level release to crates.io when this is done (if no semver breaking changes have been merged yet) so the most up-to-date docs show up on docs.rs
@jcdyer jcdyer added the enhancement New feature or request label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant