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

Add docs for tracing_subscriber/slog #68

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Add docs for tracing_subscriber/slog #68

merged 1 commit into from
Aug 29, 2024

Conversation

nick42d
Copy link
Contributor

@nick42d nick42d commented Aug 29, 2024

Closes #67.

  1. Utilises the doc_cfg attribute to show documentation for non-default docs by default on docs.rs. This also benefits the slog feature. https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577
  2. Added some implementation information and information about Adjust the log level of tracing #66 to the pre-existing docs

This will build as expected on docs.rs with no additional effort as they run nightly rust. However, to build docs locally, you will need to run the following command to mimic docs.rs environment.

cargo +nightly rustdoc -p tui-logger --all-features -- --cfg docsrs

Here's an example of the new page for TuiTracingSubscriberLayer
image

@gin66 gin66 merged commit 64129b1 into gin66:master Aug 29, 2024
4 checks passed
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.

Docs: Document use of tracing-subscriber
2 participants