Skip to content

Commit a79bec6

Browse files
author
bors-servo
authored
Auto merge of #371 - nical:doc-fix, r=kvark
Fix doc about default aliases. Fixes #370. <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/euclid/371) <!-- Reviewable:end -->
2 parents 076ac1a + 621bc25 commit a79bec6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
//! a screen-space position by a world-space vector and this can be expressed using
1919
//! the generic Unit parameter.
2020
//!
21-
//! This unit system is not mandatory and all * structures have an alias
21+
//! This unit system is not mandatory and all structures have an alias
2222
//! with the default unit: `UnknownUnit`.
23-
//! for example ```Point2D<T>``` is equivalent to ```Point2D<T, UnknownUnit>```.
23+
//! for example ```default::Point2D<T>``` is equivalent to ```Point2D<T, UnknownUnit>```.
2424
//! Client code typically creates a set of aliases for each type and doesn't need
2525
//! to deal with the specifics of typed units further. For example:
2626
//!
@@ -98,6 +98,8 @@ mod nonempty;
9898
pub struct UnknownUnit;
9999

100100
pub mod default {
101+
//! A set of aliases for all types, tagged with the default unknown unit.
102+
101103
use super::UnknownUnit;
102104
pub type Point2D<T> = super::Point2D<T, UnknownUnit>;
103105
pub type Point3D<T> = super::Point3D<T, UnknownUnit>;

0 commit comments

Comments
 (0)