From e614817e5309535fb9d49f312c0784c00c8f6e8b Mon Sep 17 00:00:00 2001 From: Taiki Endo Date: Fri, 31 Jan 2025 17:24:33 +0900 Subject: [PATCH] docs: Use Alerts of GitHub Flavored Markdown https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c615c8b..41fa45a 100644 --- a/README.md +++ b/README.md @@ -435,7 +435,8 @@ cargo llvm-cov --no-report --features b cargo llvm-cov report --lcov # generate report without tests ``` -Note: To include coverage for doctests you also need to pass `--doctests` to `cargo llvm-cov report`. +> [!TIP] +> To include coverage for doctests you also need to pass `--doctests` to `cargo llvm-cov report`. ### Get coverage of C/C++ code linked to Rust library/binary @@ -476,10 +477,13 @@ cargo build # Build rust binaries. cargo llvm-cov report --lcov # Generate report without tests. ``` -Note: cargo-llvm-cov subcommands other than `report` and `clean` may not work correctly in the context where environment variables are set by `show-env`; consider using normal `cargo`/`cargo-nextest` commands. +> [!CAUTION] +> cargo-llvm-cov subcommands other than `report` and `clean` may not work correctly in the context where environment variables are set by `show-env`; consider using normal `cargo`/`cargo-nextest`/etc. commands. -Note: To include coverage for doctests you also need to pass `--doctests` to both `cargo llvm-cov show-env` and `cargo llvm-cov report`. +> [!TIP] +> To include coverage for doctests you also need to pass `--doctests` to both `cargo llvm-cov show-env` and `cargo llvm-cov report`. +> [!TIP] > The same thing can be achieved in PowerShell 6+ by substituting the source command with: > > ```powershell