readability improvements #36

Closed
wants to merge 4 commits into
from

Projects

None yet

2 participants

@randrewj
Contributor

Thank you for providing this document.
These changes offer a few small readability improvements.

@mariusae mariusae and 1 other commented on an outdated diff Feb 23, 2014
effectivescala.mo
@@ -254,7 +254,7 @@ compatibility.
### Variance
-Variance arises when generics are combined with subtyping. They define
+Variance arises when generics are combined with subtyping. Variance annotations define
@mariusae
mariusae Feb 23, 2014 Contributor

"They" have an antecedent in this case -- Variance is not the same as Variance annotations.

@randrewj
randrewj May 2, 2014 Contributor

The antecedent is singular, though, which makes "they" confusing. "It defines how..." would be better.

@mariusae mariusae and 1 other commented on an outdated diff Feb 23, 2014
effectivescala.mo
@@ -877,9 +877,9 @@ readily modelled with ADTs; these occur frequently in state machines.
### Options
The `Option` type is a container that is either empty (`None`) or full
-(`Some(value)`). They provide a safe alternative to the use of `null`,
-and should be used in their stead whenever possible. They are a
-collection (of at most one item) and they are embellished with
+(`Some(value)`). It provides a safe alternative to the use of `null`,
+and should be used instead of `null` whenever possible. It is a
@mariusae
mariusae Feb 23, 2014 Contributor

It is a -> How about "Options are collections .., and are embellished

@randrewj
randrewj May 2, 2014 Contributor

Yes, that's good.

@mariusae
Contributor
mariusae commented May 2, 2014

@randrewj are you going to push an updated pull request?

andrew added some commits Aug 9, 2014
@randrewj
Contributor
randrewj commented Aug 9, 2014

Sorry for the lag Marius. Here are updated suggestions.

@randrewj
Contributor

I'll revisit this and submit a new request.

@randrewj randrewj closed this Aug 13, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment