Skip to content

Fixed code example (2) #1597

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 28 commits into from
Jul 29, 2012
Merged

Fixed code example (2) #1597

merged 28 commits into from
Jul 29, 2012

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Jul 26, 2012

This is, or at least I hope it is, the last PR for fixing the code standards. I have fixed the bash code examples and I have added the standards to contributing/documentation/overview.

Please take a look at the standards, I think most of them are written in really worse english. Please ask me questions if you don't understand the sentence.

Sorry for the last 5 commits, ReSt isn't my best format language...

@@ -88,3 +133,5 @@ Read the dedicated :doc:`document <translations>`.
.. _`fork`: http://help.github.com/fork-a-repo/
.. _`pull requests`: http://help.github.com/pull-requests/
.. _`Documentation Build Errors`: http://symfony.com/doc/build_errors
.. _`Symfony Coding Standards`: http://symfony.com/doc/current/contributing/code/standards.html
Copy link
Member

Choose a reason for hiding this comment

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

this one is not used

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch! It was used but then I switched to a :doc: link. I will remove it.

weaverryan added a commit that referenced this pull request Jul 29, 2012
@weaverryan weaverryan merged commit e262aa6 into symfony:2.0 Jul 29, 2012
weaverryan added a commit that referenced this pull request Jul 29, 2012
@weaverryan
Copy link
Member

Hey there!

This is an excellent start to the coding standards for the docs - a lot of this has never really been formalized until now. If the community decides differently on any of these standards, we may tweak them over time, but having them concretely is excellent!

I did make some tweaks to your standards section - but all tiny things.

Thanks!

@wouterj
Copy link
Member Author

wouterj commented Jul 29, 2012

Thank you @weaverryan ! The original text was writen in Markdown (for this PR system) and I forgot to change the inline code blocks!

The only thing I disagree is the public before the function. It isn't in a class scope and when it is you should place a // ... in front of it, I think.

And maybe the max. line length rule? Nobody knows that and there first PR.

Does anyone know why this don't appear at the symfony website? ( http://symfony.com/doc/current/contributing/documentation/overview.html )

@weaverryan
Copy link
Member

@wouterj the problem with the public is that we really don't ever use flat functions anywhere - only methods, so the example isn't really useful unless it's a class method. I've tweaked things at sha: aae3a5f and sha: 4f8ff0e

Let me know if you see any changes needed. I'm not sure why things aren't rendered yet - the docs haven't been rendering as quickly lately as they normally do.

@wouterj
Copy link
Member Author

wouterj commented Jul 31, 2012

@weaverryan it looks great now! Thank you!

I will check the code examples that are new in the master branch and create the last PR for this... (finally)

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