Skip to content

Commit 0379584

Browse files
authored
docs: fix typos and add crate links in README (#3336)
Docs only, no effect on code or functionality.
1 parent 96d2376 commit 0379584

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
1919
[mit-url]: LICENSE
2020
[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
21-
[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
21+
[actions-url]: https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
2222
[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
2323
[discord-url]: https://discord.gg/EeF3cQw
2424

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

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

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

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

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

337337
[`tracing`]: tracing
338338
[`tracing-core`]: tracing-core
@@ -364,6 +364,15 @@ The crates included as part of Tracing are:
364364
[app-crates]: https://crates.io/crates/tracing-appender
365365
[app-docs]: https://docs.rs/tracing-appender
366366

367+
[err-crates]: https://crates.io/crates/tracing-error
368+
[err-docs]: https://docs.rs/tracing-error
369+
370+
[flame-crates]: https://crates.io/crates/tracing-flame
371+
[flame-docs]: https://docs.rs/tracing-flame
372+
373+
[jour-crates]: https://crates.io/crates/tracing-journald
374+
[jour-docs]: https://docs.rs/tracing-journald
375+
367376
## Related Crates
368377

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

0 commit comments

Comments
 (0)