Skip to content

Commit 1f46b8a

Browse files
committed
docs: Add clause to import policy section
1 parent 785e14c commit 1f46b8a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/policy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,13 @@ pub use units::{foo, FooBar};
117117
pub use units::foo::SomeError;
118118
```
119119

120+
### Usage of re-exports
121+
122+
As part of the attempt to mirror the `units` and `primitives`, and `bitcoin` APIs, in this codebase,
123+
policy is to use types from the highest crate available i.e `use crate::Foo` not `units::Foo`.
124+
125+
This is enforced by CI.
126+
120127
## Return `Self`
121128

122129
Use `Self` as the return type instead of naming the type. When constructing the return value use

0 commit comments

Comments
 (0)