From 3cbf4d95db7d95ef1ae37a97b0e4d6335664067a Mon Sep 17 00:00:00 2001 From: WouterJ Date: Mon, 30 Jun 2014 23:06:05 +0200 Subject: [PATCH 1/4] Fixed invalid nesting --- contributing/documentation/standards.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 821252113bf..a46dea693a5 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -85,10 +85,10 @@ 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"*). + 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*"). + 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. From 0cd3d89912c7adbaada0e3de5e7603ec1825c9e0 Mon Sep 17 00:00:00 2001 From: WouterJ Date: Mon, 30 Jun 2014 23:07:05 +0200 Subject: [PATCH 2/4] Reoutlined the standards --- contributing/documentation/standards.rst | 38 ++++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index a46dea693a5..57cd8933c4c 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.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 ------------------ From f43fa0d879f51195d36fefac89df31569aa218b7 Mon Sep 17 00:00:00 2001 From: WouterJ Date: Mon, 30 Jun 2014 23:09:48 +0200 Subject: [PATCH 3/4] comply to dir structure standards --- .../configuration/override_dir_structure.rst | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/cookbook/configuration/override_dir_structure.rst b/cookbook/configuration/override_dir_structure.rst index 73f2016c36c..0a8faad93f8 100644 --- a/cookbook/configuration/override_dir_structure.rst +++ b/cookbook/configuration/override_dir_structure.rst @@ -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: From be09679d89e3d05e9c464db3a078a650a719815e Mon Sep 17 00:00:00 2001 From: WouterJ Date: Mon, 30 Jun 2014 23:10:09 +0200 Subject: [PATCH 4/4] tried fixing code block rendering --- cookbook/configuration/override_dir_structure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cookbook/configuration/override_dir_structure.rst b/cookbook/configuration/override_dir_structure.rst index 0a8faad93f8..2f0382e8984 100644 --- a/cookbook/configuration/override_dir_structure.rst +++ b/cookbook/configuration/override_dir_structure.rst @@ -95,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 { ...