Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

docs(guides): several fixes (links, typos, syntax, line lengths) #837

Closed
wants to merge 1 commit into from

Conversation

gkalpak
Copy link
Member

@gkalpak gkalpak commented Dec 3, 2014

I started out fixing line-length to comply to the max. 100 chars per line rule (as discussed here), but this turned out to be a more generic error fixing:

  • Fixes wrong or broken links
  • Fixed typos/punctuation/syntactic errors
  • Rephrazed at a couple of places, where the wording sounded unclear or confusing
  • Wrapped lines at 100 characters

The diff may seem a little weird due to the line-wrapping.

I have re-read all the modified documents and tried all the links (and everything seems fine), but a 2nd pair of eyes is always irreplaceable 😃

@googlebot
Copy link

CLAs look good, thanks!

@gkalpak
Copy link
Member Author

gkalpak commented Dec 3, 2014

A couple more notes/issues:

  1. In PULL_REQUESTS.md:
    • It is mentioned that commit messages should "pass our commit message presubmit hook validate-commit-msg.js". But there is no such script.
      Should we bring it over from AngularJS or remove the corresponginfg line from PULL_REQUESTS.md ?
  2. In CODING.md:
  3. In COTRIBUTING.md:

@gkalpak gkalpak force-pushed the docs-guides-fixes branch 3 times, most recently from 14ecdba to 1e357b6 Compare December 10, 2014 09:37
@gkalpak
Copy link
Member Author

gkalpak commented Dec 10, 2014

It would be great if someone could take a look at this and merge it some time "soon-ish". It's purely docs.
There are a lot of files/lines affected and having to rebase on master is not painless.

@ThomasBurleson
Copy link
Contributor

@gkalpak - I will review later this morning.

@gkalpak gkalpak mentioned this pull request Dec 10, 2014

![venn](https://cloud.githubusercontent.com/assets/210413/5077572/30dfc2f0-6e6a-11e4-9723-07c918128f4f.png)

This project is in early pre-release. Angular Material is both a reference implementation of Material Design and a complementary effort to the [Polymer](http://www.polymer-project.org/) project's [Paper Elements](http://www.polymer-project.org/docs/elements/paper-elements.html) collection.
This project is in early pre-release. Angular Material is both a reference implementation of
Copy link
Contributor

Choose a reason for hiding this comment

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

In the future, please add linebreaks as it makes side-by-side git reviews very difficult.

Copy link
Member Author

Choose a reason for hiding this comment

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

The reason side-by-side review is difficult is because I have linebreaks, but the old version didn't. Basically, the original intent of this PR was to apply the max. 100 chars/line rule the docs, because the long lines made reviews difficult. So, hopefully, future reviews will be much easier :)

@ThomasBurleson
Copy link
Contributor

Will merge now. Thx @gkalpak

@gkalpak
Copy link
Member Author

gkalpak commented Dec 11, 2014

@ThomasBurleson: Many thx for reviewing (and merging) - I know it was tedious.

BTW, you might want to take a look at #837 (comment).
(For (1), I believe some action is required. For (2), just a confirmation that nothing needs to be changed. (3), you can just ignore.)

@ThomasBurleson
Copy link
Contributor

@gkalpak - Will do. Thx for the alert.

@gkalpak gkalpak deleted the docs-guides-fixes branch December 11, 2014 09:48
@ThomasBurleson
Copy link
Contributor

@gkalpak re > your comments above "A couple more notes/issues"

(1) Fixed
(2) Good point... Fixed in SHA 629b753
(3) Those examples are reasonable because they present an issue with a snapshot and reference to a the spec. Other reasonable examples would be snapshots with formatted code snippets, etc. You are welcome to suggest others that you feel are more appropriate.

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

Successfully merging this pull request may close these issues.

3 participants