Skip to content

Conversation

@n8v
Copy link

@n8v n8v commented Apr 4, 2011

I tidied up a few sentences in the Quick Tour.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to wrap the line

@n8v
Copy link
Author

n8v commented Apr 5, 2011

OK I think I did the fixing right?

@n8v n8v closed this Apr 5, 2011
@n8v n8v reopened this Apr 5, 2011
@n8v
Copy link
Author

n8v commented Apr 5, 2011

sorry sorry, total git and github newbie!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wrapping of this paragraph is too short by looking. the rule is to use 72 characters, not 62

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry my editor defaulted to that; I will fix it. I was guessing it was 80 characters...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrapping at 72 was much shorter than the original so I use 80 characters to make it match. I can wrap everything at 72 if you like.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weaverryan told me once that 72 was used in the doc but it is not done by all contributors.
I think it should be documented somewhere and done once in the whole doc to harmonize it if this rule is enforced.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll get clarification, but as I understand it, the rule is (approximately) to put a line break after the first line that crosses the 72nd character. So, line lengths will usually be somewhere between 72 and 78 characters depending on the last word.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a fill-column of 78 for Emacs. Do you want me to rewrap all the paragraphs at that length as part of this pull request?

@weaverryan weaverryan merged commit 2bbf442 into symfony:master Apr 8, 2011
@weaverryan
Copy link
Member

Thanks Nathan - very good stuff here. I tweaked a few parts - mostly because your changes highlighted a few areas that were weak and needed a little more drastic improvement.

As one of our native English speakers (I'm assuming, since you're in Alaska), I hope to see a few more pull requests from you ;)

Thanks!

@n8v
Copy link
Author

n8v commented Apr 8, 2011

You're welcome, and I hope to contribute more. I'm behind the curve on git but reasonably competent with English, sometimes. I am grateful for Symfony and everything you all do and hope to contribute more. Cheers!

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

Labels

None yet

3 participants