docs: fix syntax errors and grammar in policy.md
What the developer wrote
Authored by Klaklax
docs: fix syntax errors and grammar in policy.md
What changed, and why it matters
This commit fixes two minor mistakes in a documentation file: a missing 'fn' keyword in a code example and a duplicated word ('do should not' → 'should not'). These are purely cosmetic documentation corrections with no effect on actual code behavior or security.
No security action needed. Treat as a normal documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies docs/policy.md only. It corrects a Rust syntax error in an illustrative code snippet (‘pub some_function()’ → ‘pub fn some_function()’) and a grammatical typo (‘do should not’ → ‘should not’). Neither change touches compiled source code, APIs, or any security-sensitive logic.
Changed components
docs/policy.mdInspect captured patch +2 / −2
diff --git a/docs/policy.md b/docs/policy.md
index 183960c5..9b6b7332 100644
--- a/docs/policy.md
+++ b/docs/policy.md
@@ -93,7 +93,7 @@ pub mod foo {
pub struct FooBar { ... };
/// Some function.
- pub some_function() -> SomeError {
+ pub fn some_function() -> SomeError {
// Example error logic
SomeError::Foo(FooError { ... })
}
@@ -331,7 +331,7 @@ enum Foo {
}
```
-For types that do should not form a total or partial order, or that technically do but it does not
+For types that should not form a total or partial order, or that technically do but it does not
make sense to compare them, we use the `Ordered` trait from the
[`ordered`](https://crates.io/crates/ordered) crate. See `absolute::LockTime` for an example.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.