Skip to content

docs: fix typos and add crate links in README #3336

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos and add crate links in README #3336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: LICENSE
[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
[actions-url]: https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
[discord-url]: https://discord.gg/EeF3cQw

Expand Down Expand Up @@ -136,7 +136,7 @@ use tracing::{debug, error, info, span, warn, Level};

// the `#[tracing::instrument]` attribute creates and enters a span
// every time the instrumented function is called. The span is named after the
// the function or method. Parameters passed to the function are recorded as fields.
// function or method. Parameters passed to the function are recorded as fields.
#[tracing::instrument]
pub fn shave(yak: usize) -> Result<(), Box<dyn Error + 'static>> {
// this creates an event at the DEBUG level with two fields:
Expand Down Expand Up @@ -326,13 +326,13 @@ The crates included as part of Tracing are:
and non-blocking writer. ([crates.io][app-crates]|[docs][app-docs])

* [`tracing-error`]: Provides `SpanTrace`, a type for instrumenting errors with
tracing spans
tracing spans. ([crates.io][err-crates]|[docs][err-docs])

* [`tracing-flame`]; Provides a layer for generating flame graphs based on
tracing span entry / exit events.
* [`tracing-flame`]: Provides a layer for generating flame graphs based on
tracing span entry / exit events. ([crates.io][flame-crates]|[docs][flame-docs])

* [`tracing-journald`]: Provides a layer for recording events to the
Linux `journald` service, preserving structured data.
Linux `journald` service, preserving structured data. ([crates.io][jour-crates]|[docs][jour-docs])

[`tracing`]: tracing
[`tracing-core`]: tracing-core
Expand Down Expand Up @@ -364,6 +364,15 @@ The crates included as part of Tracing are:
[app-crates]: https://crates.io/crates/tracing-appender
[app-docs]: https://docs.rs/tracing-appender

[err-crates]: https://crates.io/crates/tracing-error
[err-docs]: https://docs.rs/tracing-error

[flame-crates]: https://crates.io/crates/tracing-flame
[flame-docs]: https://docs.rs/tracing-flame

[jour-crates]: https://crates.io/crates/tracing-journald
[jour-docs]: https://docs.rs/tracing-journald

## Related Crates

In addition to this repository, here are also several third-party crates which
Expand Down