Skip to content

[Cookbook] apply headline guidelines to the cookbook articles #4042

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

Merged
merged 1 commit into from
Jul 29, 2014

Conversation

xabbuh
Copy link
Member

@xabbuh xabbuh commented Jul 20, 2014

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets

This completes the work started in #3765, #3828 and #3829.

@xabbuh xabbuh changed the title apply headline guidelines to the cookbook articles [Cookbook] apply headline guidelines to the cookbook articles Jul 20, 2014
@javiereguiluz
Copy link
Member

👍 Awesome work @xabbuh!

Somewhat related to this, do you think it could be necessary to updated the documentation standards related to capitalization and closed-class words? Currently is just a link to a very dense Wikipedia article.

@wouterj
Copy link
Member

wouterj commented Jul 23, 2014

@javiereguiluz what would you update? The text itself does say it all actually, no need to click on the link

@javiereguiluz
Copy link
Member

@wouterj you are right that the standard clearly states the rule:

Capitalization of the first word, and all other words, except for closed-class words.

The problem is that, as any other "rule" related to human languages, the "closed-class word" concept seems arbitrary. In other words: Which is the simplest rule to unequivocally, and without any exception, identify a closed-class word in English?

@wouterj
Copy link
Member

wouterj commented Jul 23, 2014

"a closed class (or closed word class) is a word class to which no new items can normally be added" http://en.wikipedia.org/wiki/Closed_class We might want to link to that wiki page instead

@weaverryan
Copy link
Member

Thanks Christian :). If we want to add a link to the closed class wiki, let's do it. Unfortunately, it'll never be totally clear and many people won't notice this anyways. Fortunately, it's not mission critical anyways. I've mostly been relying on @xabbuh for this - he really seems to understand it. Ideally, we'd have our own fabbot that just proposed a patch to fix your title.

@weaverryan weaverryan merged commit 1fa40f3 into symfony:2.3 Jul 29, 2014
weaverryan added a commit that referenced this pull request Jul 29, 2014
…cles (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

[Cookbook] apply headline guidelines to the cookbook articles

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

This completes the work started in #3765, #3828 and #3829.

Commits
-------

1fa40f3 apply headline guidelines to the cookbook articles
@wouterj
Copy link
Member

wouterj commented Jul 29, 2014

I've mostly been relying on @xabbuh for this - he really seems to understand it.

I think it's better then to not show you #3894 (comment) and #3894 (comment) 😉

Ideally, we'd have our own fabbot that just proposed a patch to fix your title.

You'll have a Ryanbot in 2015. However, i think it'll be hard to teach this to a bot.

@xabbuh xabbuh deleted the headline-standards-cookbook branch July 29, 2014 16:28
@xabbuh
Copy link
Member Author

xabbuh commented Jul 29, 2014

Thanks Ryan. But yeah, @wouterj is right. There are some words or usages of words where we are not sure how to write them. Would be great to have your comment on them. :)

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

Successfully merging this pull request may close these issues.

4 participants