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

§10.6: Hard to Read Sentence #30

Closed
tajmone opened this issue Nov 8, 2019 · 1 comment
Closed

§10.6: Hard to Read Sentence #30

tajmone opened this issue Nov 8, 2019 · 1 comment
Assignees
Labels
🕑 pending decision Issue requires decisions by maintainers 💀 text problems Text problems, typos or obsolete contents.

Comments

@tajmone
Copy link
Owner

tajmone commented Nov 8, 2019

@tessman:

In §10.6. Vehicles the sentence:

The preposition property defaults in the vehicle class itself defaults to "in" and "out", but in the case of a horse should be changed to the more suitable "on" and "off".

is hard to read due to the double occurring "defaults", which introduces ambiguity as to which one is a verb — it comes natural to interpret the first occurrence as the verb, which then breaks the sentence at the second occurrence, forcing to read the whole sentence again.

Something like this might be smoother on the reader (and shorter too):

In the vehicle class the preposition property defaults to "in" and "out", but in the case of a horse it should be changed to the more suitable "on" and "off".

Of course, the sentence is grammatically correct, but I've found it quite hard to read through in one go, and it struck me as one of the very few places in the whole book where the reading flow was abruptly interrupted. We might as well take this reprint as a change to polish it.

References

@tajmone tajmone added 💀 text problems Text problems, typos or obsolete contents. 🕑 pending decision Issue requires decisions by maintainers 🕑 pending approval Issue requires approval by Ken Tessman labels Nov 8, 2019
tajmone added a commit that referenced this issue Nov 8, 2019
Remove unneeded `@TEXT` annotation and add Issue references to those
for which an issue was created (Issue #30).
@tajmone tajmone pinned this issue Nov 8, 2019
@tajmone tajmone mentioned this issue Dec 22, 2019
38 tasks
@tessman
Copy link
Collaborator

tessman commented Dec 31, 2019

I agree. The revised wording is better.

tajmone added a commit that referenced this issue Dec 31, 2019
In "§10.6. Vehicles", the hard to read sentence:

> The `preposition` property DEFAULTS in the `vehicle` class itself
> DEFAULTS to..."

was fixed (with @tessman approval) to the easier (and shorter):

> In the `vehicle` class the `preposition` property DEFAULTS to...

* Documented changes in `CHANGES.md`.
* Rebuild book.

(Closes #30)
@tajmone tajmone closed this as completed Dec 31, 2019
tajmone added a commit that referenced this issue Dec 31, 2019
In "§9.2. What Should I Be Able to Do Now?" fixed a line code that
was missing an opening double quote and a space. (Fixes #30)
@tajmone tajmone unpinned this issue Jan 8, 2020
@tajmone tajmone removed the 🕑 pending approval Issue requires approval by Ken Tessman label Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕑 pending decision Issue requires decisions by maintainers 💀 text problems Text problems, typos or obsolete contents.
Projects
None yet
Development

No branches or pull requests

2 participants