Permalink
Browse files

minor #3986 Rebased #3982 - Some minor fixes (WouterJ)

This PR was merged into the 2.3 branch.

Discussion
----------

Rebased #3982 - Some minor fixes

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

Replaces #3982

Commits
-------

be09679 tried fixing code block rendering
f43fa0d comply to dir structure standards
0cd3d89 Reoutlined the standards
3cbf4d9 Fixed invalid nesting
  • Loading branch information...
weaverryan committed Jul 2, 2014
2 parents 4a9e49e + be09679 commit b67a059d5ff8c45482df135ed8dda5b3bcc81f3a
Showing with 33 additions and 32 deletions.
  1. +19 −19 contributing/documentation/standards.rst
  2. +14 −13 cookbook/configuration/override_dir_structure.rst
@@ -81,25 +81,6 @@ Configuration examples should show all supported formats using
* **Validation**: YAML, Annotations, XML, PHP
* **Doctrine Mapping**: Annotations, YAML, XML, PHP
Files and Directories
~~~~~~~~~~~~~~~~~~~~~
* When referencing directories, always add a trailing slash to avoid confusions
with regular files (e.g. *"execute the ``console`` script located at the ``app/``
directory"*).
* When referencing file extensions explicitly, you should include a leading dot
for every extension (e.g. "*XML files use the ``.xml`` extension*").
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
top level directory. E.g.
.. code-block:: text
your-project/
├─ app/
├─ src/
├─ vendor/
└─ ...
Example
~~~~~~~
@@ -133,6 +114,25 @@ Example
In YAML you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
but this should not be done in Twig (e.g. ``{'hello' : 'value'}``).
Files and Directories
---------------------
* When referencing directories, always add a trailing slash to avoid confusions
with regular files (e.g. "execute the ``console`` script located at the ``app/``
directory").
* When referencing file extensions explicitly, you should include a leading dot
for every extension (e.g. "XML files use the ``.xml`` extension").
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
top level directory. E.g.
.. code-block:: text
your-project/
├─ app/
├─ src/
├─ vendor/
└─ ...
Language Standards
------------------
@@ -10,18 +10,19 @@ directory structure is:
.. code-block:: text
app/
cache/
config/
logs/
...
src/
...
vendor/
...
web/
app.php
...
your-project/
├─ app/
│ ├─ cache/
│ ├─ config/
│ ├─ logs/
│ └─ ...
├─ src/
│ └─ ...
├─ vendor/
│ └─ ...
└─ web/
├─ app.php
└─ ...
.. _override-cache-dir:
@@ -94,7 +95,7 @@ may need to modify the paths inside these files::
Since Symfony 2.1 (in which Composer is introduced), you also need to change
the ``extra.symfony-web-dir`` option in the ``composer.json`` file:
.. code-block:: json
.. code-block:: javascript
{
...

0 comments on commit b67a059

Please sign in to comment.