Skip to content

Documentation for Rust SDK #34

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

Merged
merged 25 commits into from
Dec 4, 2024
Merged

Documentation for Rust SDK #34

merged 25 commits into from
Dec 4, 2024

Conversation

gvdongen
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Nov 29, 2024

Test Results

  5 files  ±0    5 suites  ±0   2m 9s ⏱️ +11s
 45 tests ±0   45 ✅ ±0  0 💤 ±0  0 ❌ ±0 
114 runs  ±0  114 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 41ee512. ± Comparison against base commit 391d841.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@slinkydeveloper slinkydeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a first pass, haven't finished yet.

General comment I have is to use more aggressively links, and link to the trait functions directly when it makes sense.

Thanks for tackling this BTW!

src/lib.rs Outdated
Comment on lines 196 to 197
//! You can set the logging level of the Rust SDK via the `RESTATE_LOGGING` environment variable and the level values can be `TRACE`, `DEBUG`, `INFO`, `WARN` or `ERROR`.
//! The default log level is `INFO`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the full story, we don't embed tracing ourselves.

You need to tell people that the rust SDK uses the tracing crate, so you need to configure tracing_subscriber to get logs. And then give an example with tracing_subscriber::fmt::init() as in one of the examples above, and send them to the tracing subscriber doc: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/index.html#filtering-events-with-environment-variables

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check if it's okay now?

gvdongen and others added 10 commits November 29, 2024 15:25
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
gvdongen and others added 3 commits November 29, 2024 16:41
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
@gvdongen gvdongen merged commit ff4e30b into main Dec 4, 2024
3 checks passed
@gvdongen gvdongen deleted the docs branch December 4, 2024 09:44
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

Successfully merging this pull request may close these issues.

2 participants