Prepare 0.10.4 release; DashIterator doc #319
Conversation
Improve documentation of DashIterator and bump version in preparation for release.
There was a problem hiding this comment.
Just bikeshedding a bit: I wasn’t aware this was already public. The API incongruity (with segments and maybe flatten) is a bit unfortunate. I would have preferred fn dash(…) -> impl Iterator (or -> Dash if following Rust naming guidelines and matching Segments if we want the concrete type exposed).
src/stroke.rs
Outdated
| @@ -613,6 +613,18 @@ const DASH_ACCURACY: f64 = 1e-6; | |||
|
|
|||
| impl<'a, T: Iterator<Item = PathEl>> DashIterator<'a, T> { | |||
| /// Create a new dashing iterator. | |||
| /// | |||
| /// Handling of dashes is fairly orthogonal to stroke expansion. This iterator | |||
There was a problem hiding this comment.
Perhaps this comment should be attached to the type instead?
|
I'm ok with changing it to look like a function. That should probably be a bump to 0.11, as it would certainly be semver breaking, unless we left it in as an alias with doc(hidden) maybe. If it were changed to a function, the main comment should be attached to that, not the type, yes? |
|
I was thinking the same thing wrt doc(hidden) :) And yes, the lovely new doc comment should be on the function in this case. |
As per review comments
Improve documentation of DashIterator and bump version in preparation for release.