You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use the following command to auto-generate the contents of README.md from the crate-level doc comment in src/lib.rs:
cargo readme | sed 's/\[\(`[^`]*`\)]/\1/g'
The sed command removes code links like:
/// Here is a link to [`Vec<u8>`].
We should add a test that the output of that command matches the current contents of README.md, which will ensure PRs which edit that doc comment but do not update README.md can't be spuriously merged.
The text was updated successfully, but these errors were encountered:
We use the following command to auto-generate the contents of
README.md
from the crate-level doc comment insrc/lib.rs
:The
sed
command removes code links like:/// Here is a link to [`Vec<u8>`].
We should add a test that the output of that command matches the current contents of
README.md
, which will ensure PRs which edit that doc comment but do not updateREADME.md
can't be spuriously merged.The text was updated successfully, but these errors were encountered: