Merge rust-bitcoin#5058: docs: fix syntax errors and grammar in policy.md

apoelstra · apoelstra · commit ed98e3036cad · 2025-09-30T19:08:23.000Z
6def722 docs: fix syntax errors and grammar in policy.md (Klaklax) Pull request description: ### Description Correct missing `fn` keyword in function declaration example. Remove redundant `do` word from sentence describing type ordering constraints. ACKs for top commit: apoelstra: ACK 6def722; successfully ran local tests Tree-SHA512: 9373db48c37d4b0d89b1cb10d772d84af68994b80495fe6b705d341a974152f85365ea4aee58f87993636f6258364e168b447997f2863c026eebc178e0552357
diff --git 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.
 

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ pub mod foo {`
`93`	`93`	`pub struct FooBar { ... };`
`94`	`94`
`95`	`95`	`/// Some function.`
`96`		`- pub some_function() -> SomeError {`
	`96`	`+ pub fn some_function() -> SomeError {`
`97`	`97`	`// Example error logic`
`98`	`98`	`SomeError::Foo(FooError { ... })`
`99`	`99`	`}`
`@@ -331,7 +331,7 @@ enum Foo {`
`331`	`331`	`}`
`332`	`332`	```
`333`	`333`
`334`		`-For types that do should not form a total or partial order, or that technically do but it does not`
	`334`	`+For types that should not form a total or partial order, or that technically do but it does not`
`335`	`335`	make sense to compare them, we use the `Ordered` trait from the
`336`	`336`	[`ordered`](https://crates.io/crates/ordered) crate. See `absolute::LockTime` for an example.
`337`	`337`