Skip to content

cleanup documentation pages #160

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
Oct 19, 2016
Merged

cleanup documentation pages #160

merged 1 commit into from
Oct 19, 2016

Conversation

dbu
Copy link
Contributor

@dbu dbu commented Oct 18, 2016

make style more consistent and improve some wordings

@dbu dbu force-pushed the doc-style-cleanup branch from 4c79c69 to 20b0de7 Compare October 18, 2016 08:35
Copy link
Member

@Nyholm Nyholm left a comment

Choose a reason for hiding this comment

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

Great job!

3. Plugins which log information should be last (like Logger or History Plugin)
1. Plugins that modify the request should be at the beginning (like Authentication or Cookie Plugin);
2. Plugins which intervene in the workflow should be in the "middle" (like Retry or Redirect Plugin);
3. Plugins which log information should be last (like Logger or History Plugin).
Copy link
Member

Choose a reason for hiding this comment

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

I've never seen semi colons at the end of a list like this.

I suggest removing them and also the period.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is the symfony doc style afaik. i can't find it mentioned explicitly on http://symfony.com/doc/current/contributing/documentation/standards.html#code-examples but at least that example also has them.

but i am fine with removing them again if others also don't like them. i got used to them, so i'd vote to keep doing them, but its no big deal for me.

Copy link
Member

Choose a reason for hiding this comment

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

Okey, I just have not noticed that.

Let's keep them.

@Nyholm
Copy link
Member

Nyholm commented Oct 18, 2016

I'm 👍

Ready for merge?

@dbu dbu merged commit 9059cb7 into master Oct 19, 2016
@dbu dbu deleted the doc-style-cleanup branch October 19, 2016 12:09
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.

3 participants