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

Documentation clean up and consistency. #17625

Closed
wants to merge 2 commits into from
Closed

Conversation

bhamodi
Copy link
Contributor

@bhamodi bhamodi commented Sep 16, 2015

@mdo - just some general clean up of your .md files. 👍

@@ -28,7 +28,7 @@ restrictions:
[`Normalize`](https://github.com/necolas/normalize.css) (open them in
their respective repositories).

* Please **do not** open issues regarding the official themes offered on <http://themes.getbootstrap.com/>. Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`.
* Please **do not** open issues regarding the official themes offered on <http://themes.getbootstrap.com/>. Instead, please email any questions or feedback regarding those themes to <themes@getbootstrap.com>.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It was formatted that way as an anti-spam defense measure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh interesting... To prevent from spammers that scrape GitHub for email addresses?
I'll revert this change.

@bhamodi
Copy link
Contributor Author

bhamodi commented Sep 16, 2015

Addressed your feedback @cvrebert.

@bhamodi
Copy link
Contributor Author

bhamodi commented Sep 26, 2015

Ping @cvrebert and @mdo, any update on this?

@cvrebert cvrebert self-assigned this Sep 27, 2015
@@ -124,7 +124,7 @@ provide as much detail and context as possible.

## Pull requests

Good pull requestspatches, improvements, new featuresare a fantastic
Good pull requests - patches, improvements, and new features - are a fantastic
Copy link
Member

Choose a reason for hiding this comment

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

Em dashes don't require spaces on the sides.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, the reason I made this change is because when I first read this line without the spaces, it seems like "request-patches" was one hyphenated word. The spaces symbolize that it is rather offset parenthetical information. (See: http://www.grammarly.com/handbook/punctuation/dash/2/dash-parenthetical-information/)

Copy link
Member

Choose a reason for hiding this comment

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

It comes down to style/preference. As a rule, em dashes do indeed not require spaces. However, most newspapers that employ the Associated Press styleguide do include spaces. Personally, I find em dashes more readable with spaces either side.

Copy link
Member

Choose a reason for hiding this comment

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

We use a number of em dashes throughout our docs I believe—let's leave it as-is for now for consistency with what's written most other places.

@cvrebert cvrebert added this to the v3.3.6 milestone Sep 28, 2015
@cvrebert cvrebert closed this in 85bc033 Sep 28, 2015
@cvrebert
Copy link
Collaborator

Merged with a couple tweaks. Thanks!

chiraggmodi pushed a commit to chiraggmodi/bootstrap that referenced this pull request Apr 8, 2019
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.

None yet

4 participants