Fixed code examples (in 2.0)

[wouterj]

This PR continues #1531

I have merged the upstream 2.0 branch into this branch and fixed the conflicts. I think this is the right way? If it isn't, I will do it the right way (if you can tell me that).

I like to know what you think about these rules:

• Do we use the sorthand :: or the codeblock .. code-block:: php for php code?
• Do we put a $ before every bash line?

And maybe it is an idea to put the 'rules' in the previous PR somewhere inside contributing/documentation (with better grammar and spelling)?

[weaverryan]

Hey there!

WOW, this is SUPER thorough. It's interesting to see all the small things that have accumulated over the last 18 months :) - thanks for taking the time to go through and normalize so many things.

To answer your questions:

• :: is always preferred for PHP
• My preference would be that we do always put $ in front of bash statements, or at least something that's standardized.

And yes, I would love to have your rules from #1531 in the docs - if you make a PR against 2.0, I'll fix up any typos/grammer stuff that there may be :)

Thank you very much!

[cursedcoder]

awesome job @wouterj !

[wouterj]

Thank you, @cursedcoder and @weaverryan !!

I will make a new PR soon with the last fixes ($ in bash lines) and add the rules to the contributing page. Do we need to change all .. codeblock:: php to :: or is it good to use them both across the documentation?

[weaverryan]

I think it's ok to have them both, we will just prefer the :: going forward. Changing them holds the risk too of messing up some code blocks and there are some cases where :: won't work :)

[wouterj]

Ok, I will add it to rules but I will not change it in the current docs.

Do I need make a PR it against weaverryan/symfony-docs, because we still cannot make it against the symfony/symfony-docs?

[weaverryan]

Actually, we found out that PR's against both seem to be broken - seems that it's anything related to symfony-docs. I'm talking with someone at GH right now about it - said they'll be looking at it ASAP, so hopefully it will be fixed soon.

For now, do the work on your local repo and we'll see if it clears up on a couple of days. You can also create an issue that references the branch on your repo - far from perfect, but I don't see another workaround.

Thanks!

[wouterj]

Does anyone know why the overview file isn't formatted as expected, what have I done wrong? https://github.com/WouterJ/symfony-docs/blob/fixed_code_example_2/contributing/documentation/overview.rst

[weaverryan]

@wouterj is this part of a different PR you're working on or do you see a formatting issue on the live site? Are you getting an error when you compile the docs?

[wouterj]

@weaverryan thank you for you comment. It's part of the 2nd part of this PR and I cannot compile it right now, my PC doesn't have Python installed. I have to wait until tomorrow and then I am going to test it.