Grammar, formatting, readability fixes [skip ci] #14851

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
3 participants
@jonatack
Contributor

jonatack commented Apr 23, 2014

No description provided.

* How to generate select boxes from multiple types of data.
-* The date and time helpers Rails provides.
+* What date and time helpers Rails provides.

This comment has been minimized.

Show comment Hide comment
@robin850

robin850 Apr 25, 2014

Member

We should use "which" instead of "what" here I think.

@robin850

robin850 Apr 25, 2014

Member

We should use "which" instead of "what" here I think.

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

@robin850 thanks for the feedback. From elementary school we were taught to begin these kind of titles with one of the following words: "Who", "What", "When", "Where", "Why" & "How". They are called the 5 Ws and H.

Kipling made it easy for us to remember:
"I keep six honest serving-men
(They taught me all I knew);
Their names are What and Why and When
And How and Where and Who."

@jonatack

jonatack Apr 25, 2014

Contributor

@robin850 thanks for the feedback. From elementary school we were taught to begin these kind of titles with one of the following words: "Who", "What", "When", "Where", "Why" & "How". They are called the 5 Ws and H.

Kipling made it easy for us to remember:
"I keep six honest serving-men
(They taught me all I knew);
Their names are What and Why and When
And How and Where and Who."

This comment has been minimized.

Show comment Hide comment
@matthewd

matthewd Apr 25, 2014

Owner

"you will know the date and time helpers" and "you will know what date and time helpers" mean rather different things, but both seem perfectly valid.

Anyway, "what" is better than "which" here.

@matthewd

matthewd Apr 25, 2014

Owner

"you will know the date and time helpers" and "you will know what date and time helpers" mean rather different things, but both seem perfectly valid.

Anyway, "what" is better than "which" here.

This comment has been minimized.

Show comment Hide comment
@robin850

robin850 Apr 25, 2014

Member

Ah sorry for the noise then ! :-)

@robin850

robin850 Apr 25, 2014

Member

Ah sorry for the noise then ! :-)

@@ -146,11 +146,9 @@ Output:
<label for="age_adult">I'm over 21</label>
```
-As with `check_box_tag`, the second parameter to `radio_button_tag` is the value of the input. Because these two radio buttons share the same name (age) the user will only be able to select one, and `params[:age]` will contain either "child" or "adult".
+As with `check_box_tag`, the second parameter to `radio_button_tag` is the value of the input. Because these two radio buttons share the same name (age), the user will only be able to select one of the two, and `params[:age]` will contain either "child" or "adult".

This comment has been minimized.

Show comment Hide comment
@robin850

robin850 Apr 25, 2014

Member

We can say "the same name (i.e. age)" here I think. Also the "of the two" addition doesn't seem worthy, this is still crystal clear at the beginning of the sentence that there are two radio buttons, what do you think ?

@robin850

robin850 Apr 25, 2014

Member

We can say "the same name (i.e. age)" here I think. Also the "of the two" addition doesn't seem worthy, this is still crystal clear at the beginning of the sentence that there are two radio buttons, what do you think ?

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

Thanks. I don't feel strongly about this, but "one of the two" refers back to "two radio buttons" which IMHO is more precise and clear.

@jonatack

jonatack Apr 25, 2014

Contributor

Thanks. I don't feel strongly about this, but "one of the two" refers back to "two radio buttons" which IMHO is more precise and clear.

This comment has been minimized.

Show comment Hide comment
@matthewd

matthewd Apr 25, 2014

Owner

I don't think "i.e." is called for... but maybe "(:age)"?

I agree that "of the two" feels more repetitious than clear... "of them"?

@matthewd

matthewd Apr 25, 2014

Owner

I don't think "i.e." is called for... but maybe "(:age)"?

I agree that "of the two" feels more repetitious than clear... "of them"?

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

"of them" could be good.

@jonatack

jonatack Apr 25, 2014

Contributor

"of them" could be good.

-NOTE: Always use labels for checkbox and radio buttons. They associate text with a specific option and,
-by expanding the clickable region,
-make it easier for users to click the inputs.
+NOTE: Always use labels for checkbox and radio buttons. They associate text with a specific option and, by expanding the clickable region, make it easier for users to click the inputs.

This comment has been minimized.

Show comment Hide comment
@robin850

robin850 Apr 25, 2014

Member

Could you please remove this change ? Actually we are slowly wrapping new additions in guides, this is why the whole file is not consistent. :-) If you want you can provide an extra commit wrapping the whole file to 80 chars (but exceptionally please do not squash them to make the review process easier).

@robin850

robin850 Apr 25, 2014

Member

Could you please remove this change ? Actually we are slowly wrapping new additions in guides, this is why the whole file is not consistent. :-) If you want you can provide an extra commit wrapping the whole file to 80 chars (but exceptionally please do not squash them to make the review process easier).

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

I agree about wrapping everything to 80 characters :) but in this case the resulting formatting of that NOTE section is currently not displaying well, at least when viewing the guide on my Retina MBP, and removing the line breaks makes the section format properly again.

@jonatack

jonatack Apr 25, 2014

Contributor

I agree about wrapping everything to 80 characters :) but in this case the resulting formatting of that NOTE section is currently not displaying well, at least when viewing the guide on my Retina MBP, and removing the line breaks makes the section format properly again.

@robin850

This comment has been minimized.

Show comment Hide comment
@robin850

robin850 Apr 25, 2014

Member

Thanks for your contribution so far @jonatack ! :-)

Member

robin850 commented Apr 25, 2014

Thanks for your contribution so far @jonatack ! :-)

@robin850 robin850 added docs labels Apr 25, 2014

@jonatack

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

Thanks for reviewing, @robin850 👍

Contributor

jonatack commented Apr 25, 2014

Thanks for reviewing, @robin850 👍

* What makes a file upload form different.
-* Some cases of building forms to external resources.
+* How to build some forms to external resources.

This comment has been minimized.

Show comment Hide comment
@matthewd

matthewd Apr 25, 2014

Owner

This needs a rephrase... "how to build some forms" means something quite different. But I agree the previous spelling can be improved.

@matthewd

matthewd Apr 25, 2014

Owner

This needs a rephrase... "how to build some forms" means something quite different. But I agree the previous spelling can be improved.

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

Agreed.
After re-reading the section in question, how about:
"How to post forms to external resources and specify setting an authenticity_token."

@jonatack

jonatack Apr 25, 2014

Contributor

Agreed.
After re-reading the section in question, how about:
"How to post forms to external resources and specify setting an authenticity_token."

jonatack added a commit to jonatack/rails that referenced this pull request Apr 25, 2014

Grammar and formatting fixes in Form Helpers Guide
Improved version of #14851 after helpful feedback from @robin850 and @matthewd.

[skip ci]
@jonatack

This comment has been minimized.

Show comment Hide comment
@jonatack

jonatack Apr 25, 2014

Contributor

Closed and feedback incorporated into #14872. Thanks.

Contributor

jonatack commented Apr 25, 2014

Closed and feedback incorporated into #14872. Thanks.

@jonatack jonatack closed this Apr 25, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment