Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API guidelines: iterator type names should match the methods that produce them. #87

Closed
nical opened this issue Jun 24, 2017 · 1 comment

Comments

@nical
Copy link
Owner

nical commented Jun 24, 2017

This is a sub-issue for #44.

We should audit the docs/code of each lyon crate and check that iterator type names match the methods that produce them`.

I know that most of the iterators in lyon crates don't follow this convention.

@nical nical modified the milestone: 1.0 Jun 24, 2017
@nical nical changed the title Rust API guidelines: C-ITER-TY API guidelines: iterator type names should match the methods that produce them. Jul 16, 2017
@nical
Copy link
Owner Author

nical commented Aug 16, 2017

Here is a list of the methods/iterators and the names they should change to:

In lyon_bezier (@anna-liao currently working on it):

  • CubicBezierSegment::flattening_iter/CubicFlatteningIter -> CubicBezierSegment::flattened/cubic_bezier::Flattened
  • QuadraticBezierSegment::flattening_iter/QudraticFlatteningIter -> QuadraticBezierSegment::flattened/quadratic_bezier::Flattened

In lyon_path:

  • PathIter -> Iter

In lyon_path_iterator:

  • FlattenginIter -> Flattened (the method name is already flattened)
  • PathStateSvgIter -> SvgPathIter (ideally PathIter but conflicts with the other one below).
  • PathStateIter -> PathIter
  • SvgToPathIter -> PathEvents

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant