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

Rename TypedFoo types into Foo #351

Merged
merged 1 commit into from Jul 2, 2019
Merged

Rename TypedFoo types into Foo #351

merged 1 commit into from Jul 2, 2019

Conversation

@nical
Copy link
Collaborator

nical commented Jun 29, 2019

Number two in a long list of breaking changes.

This removes the "Typed" prefix on most types (for example TypedRect) which is now unnecessary since the default version of these types using UnknownUnit are now in the euclid::default namespace.

For users of euclid, accustomed to manipulating the default types, this means that they don't need to look up the doc for TypedRect when they think about Rect. This doesn't seem like much but since nobody uses TypedFoo types directly other than to create aliases in a single place, the names in the documentation never match the names users actually manipulate and the Typed prefix is easily forgotten.

As a result the names are a bit prettier and the docs more intuitive.

r? anyone


This change is Reviewable

@kvark
kvark approved these changes Jul 2, 2019
Copy link
Member

kvark left a comment

Assuming this is a simple search&replace change, didn't read all of it

@nical nical force-pushed the nical:breaking-2 branch from fb399bc to 4d1cbe7 Jul 2, 2019
@nical
Copy link
Collaborator Author

nical commented Jul 2, 2019

@bors-servo r=kvark

@bors-servo
Copy link
Contributor

bors-servo commented Jul 2, 2019

📌 Commit 4d1cbe7 has been approved by kvark

bors-servo added a commit that referenced this pull request Jul 2, 2019
Rename TypedFoo types into Foo

Number two in a [long list](https://github.com/nical/euclid/commits/breaking-changes) of breaking changes.

This removes the "Typed" prefix on most types (for example TypedRect) which is now unnecessary since the default version of these types using `UnknownUnit` are now in the `euclid::default` namespace.

For users of euclid, accustomed to manipulating the default types, this means that they don't need to look up the doc for `TypedRect` when they think about `Rect`. This doesn't seem like much but since nobody uses `TypedFoo` types directly other than to create aliases in a single place, the names in the documentation never match the names users actually manipulate and the `Typed` prefix is easily forgotten.

As a result the names are a bit prettier and the docs more intuitive.

r? anyone

<!-- 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/351)
<!-- Reviewable:end -->
@bors-servo
Copy link
Contributor

bors-servo commented Jul 2, 2019

Testing commit 4d1cbe7 with merge b556870...

@bors-servo
Copy link
Contributor

bors-servo commented Jul 2, 2019

☀️ Test successful - checks-travis
Approved by: kvark
Pushing b556870 to master...

@bors-servo bors-servo merged commit 4d1cbe7 into servo:master Jul 2, 2019
2 checks passed
2 checks passed
Travis CI - Pull Request Build Passed
Details
homu Test successful
Details
@nical nical deleted the nical:breaking-2 branch Jul 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.