Skip to content

Improve readability #4722

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

Closed
wants to merge 2 commits into from
Closed

Improve readability #4722

wants to merge 2 commits into from

Conversation

ifdattic
Copy link
Contributor

Q A
Doc fix? yes
New docs? no
Applies to 2.3
Fixed tickets
  1. I personally find // ... much more understandable and less troublesome when hiding code from examples
  2. Remove horizontal scrolling
  3. Some small changes

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3
| Fixed tickets |
@ifdattic
Copy link
Contributor Author

Also I think (there's also a bin/ directory that's used to help updated vendor libraries) might use a rewording as after reading the last 3 words you feel a bit confused about what was actually mean by it.

...,
// register your bundles
// ...
// register your bundle
Copy link
Member

Choose a reason for hiding this comment

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

the standard is // ... register your bundles

Copy link
Member

Choose a reason for hiding this comment

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

hmm, wait. Sorry you are correct

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, as it's a tutorial and this is telling you what to do, the singular form works much better.

@xabbuh
Copy link
Member

xabbuh commented Dec 31, 2014

👍

wouterj added a commit that referenced this pull request Jan 2, 2015
This PR was squashed before being merged into the 2.3 branch (closes #4722).

Discussion
----------

Improve readability

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3
| Fixed tickets |

1. I personally find `// ...` much more understandable and less troublesome when hiding code from examples

2. Remove horizontal scrolling

3. Some small changes

Commits
-------

6cd1a1d Improve readability
@wouterj
Copy link
Member

wouterj commented Jan 2, 2015

Also I think (there's also a bin/ directory that's used to help updated vendor libraries) might use a rewording as after reading the last 3 words you feel a bit confused about what was actually mean by it.

I'm not sure what we try to tell in that sentence... Fortunately, I'll rewrite that chapter soon (to comply with best practices), so I'll remove this confusing sentence.

I've merged your PR into the 2.3 branch (and squashed the commits, so I have to close this PR manually)

@wouterj wouterj closed this Jan 2, 2015
@ifdattic
Copy link
Contributor Author

ifdattic commented Jan 3, 2015

Yea, I was also thinking it might come in handy to update it to the best practices.

So far I'm doing all of my PRs on Github online so sometimes there are more commits than needed.

@ifdattic ifdattic deleted the patch-7 branch January 3, 2015 10:42
@wouterj
Copy link
Member

wouterj commented Jan 3, 2015

Sqashing commits is just a simple answering Yes to sqashing, so don't worry much (github ui is great for typo fixes)

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

Successfully merging this pull request may close these issues.

3 participants