Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using foo/bar/baz examples is fine for abstract thinkers but unhelpful for applied thinkers. Using "realistic" (but neutral, non-distracting) names works for applied thinkers and is just as easy for abstract thinkers, so in my view is to be preferred. For example, instead of struct Foo bar baz end, I'd have done, e.g., struct Tag name value end, etc. Similarly, I'd replace obj with child, parent, sibling or link. I haven't done this of course because this is a doc policy decision and I'm just doing English fixes. (Well I changed xx to data since the former looks like a 'fixme' tag.)
Another global thing I've noticed is that the docs clearly have multiple authors so there is a fair amount of stylistic inconsistency. Doesn't matter for online docs, but wouldn't be nice if turned into book form.
The .md files tend to have quite long line lengths. I have tried to preserve the lines to make the diffs simpler to read but personally I'd have used a maximum line width since that's easier to edit and diff across a wide range of editors.
The OrderedPair example shows how to enforce an invariant by throwing an exception. This is fine of course, but I think an additional or alternative example should be given that shows how to preserve an invariant where possible, e.g.,
OrderedPair(x,y) = x > y ? new(y,x) : new(x,y), or a different example altogether. Unless 'fixing' like this is bad practice in Julia?
Liked the OurRational and SummedArray examples and the explanations that followed them.