Skip to content

Added filename references to examples #7452

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

Closed
wants to merge 1 commit into from
Closed

Added filename references to examples #7452

wants to merge 1 commit into from

Conversation

raitocz
Copy link
Contributor

@raitocz raitocz commented Feb 7, 2017

No description provided.

@xabbuh
Copy link
Member

xabbuh commented Feb 7, 2017

It's true that this is the standard location of the files when using the Symfony Standard Edition. However, this article also applies to the component being used standalone. So I have no clear opinion if we want to merge this.

@javiereguiluz
Copy link
Member

@xabbuh we have this recurring doubt about using the standard file locations and examples (services.yml, routing.yml, AppBundle, etc.) in the components section. My opinion is: if you are advanced enough to use the Symfony Components without the Symfony Framework, you should be smart enough to figure out that you must update the suggested file paths accordingly.

I don't know if you agree with the above, but these past weeks I've used the documentation of other technologies and it's infinitely frustrating to read docs that tell you to copy some code but they don't tell you where. They (wrongly) assume that all readers know where to put things and that's why they never show you the file paths of the code samples. 😡

@raitocz
Copy link
Contributor Author

raitocz commented Feb 7, 2017

@javiereguiluz I agree on that. This was exactly my case on this, so I wanted to help anyone else having same problem. I know that doc about routes might reference to routing configuration files but I was not sure and I had to just blindly try it, which was my first experience of this kind in otherwise well written docs, everywhere else using this helpful default config file names comments.

@xabbuh
Copy link
Member

xabbuh commented Feb 8, 2017

Sounds convincing to me. 👍 then

Status: Reviewed

@xabbuh
Copy link
Member

xabbuh commented Feb 19, 2017

Thank you @raitocz.

xabbuh added a commit that referenced this pull request Feb 19, 2017
This PR was submitted for the 3.2 branch but it was merged into the 2.7 branch instead (closes #7452).

Discussion
----------

Added filename references to examples

Commits
-------

9c2fb45 Added filename references to examples
xabbuh added a commit that referenced this pull request Feb 19, 2017
@xabbuh xabbuh closed this Feb 19, 2017
xabbuh added a commit that referenced this pull request Feb 20, 2017
* 2.7:
  Expanded the explanation and updated the example
  Update doctrine.rst
  Update console.rst
  [#7452] remove trailing whitespaces
  Added filename references to examples
  Fix Typo $response->setEtag(..)
  Fixed typo
  Replace array with null
  Added a note about the usual cURL certificate problem
  Fixed code syntax issues
  Replaced tabs with white spaces
  Replace "chapter" by "article" where appropriate
  Minor tweak
  Use statement for InputOption added to example
  Use HTTPS to link to symfony.com when possible
  fixed Backward Compatibility typo
xabbuh added a commit that referenced this pull request Feb 20, 2017
* 2.8:
  Expanded the explanation and updated the example
  Update doctrine.rst
  Update console.rst
  [#7452] remove trailing whitespaces
  Added filename references to examples
  Fix Typo $response->setEtag(..)
  Fixed typo
  Replace array with null
  Added a note about the usual cURL certificate problem
  Fixed code syntax issues
  Replaced tabs with white spaces
  Replace "chapter" by "article" where appropriate
  Minor tweak
  Use statement for InputOption added to example
  Use HTTPS to link to symfony.com when possible
  fixed Backward Compatibility typo
xabbuh added a commit that referenced this pull request Feb 20, 2017
* 3.2:
  Expanded the explanation and updated the example
  Update doctrine.rst
  Update console.rst
  [#7452] remove trailing whitespaces
  Added filename references to examples
  Fix Typo $response->setEtag(..)
  Fixed typo
  Replace array with null
  Added a note about the usual cURL certificate problem
  Fixed code syntax issues
  Fix typo
  Replaced tabs with white spaces
  Replace "chapter" by "article" where appropriate
  Minor tweak
  Use statement for InputOption added to example
  Use HTTPS to link to symfony.com when possible
  fixed Backward Compatibility typo
  Update cache_pools.rst
  [DependencyInjection][Fix] Missing RequestStack
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.

4 participants