Skip to content

Commit d5f8291

Browse files
blue-eyesfabpot
blue-eyes
authored and
fabpot
committed
Fixed last styles for all note, tip, caution,... directives
1 parent 21fe65a commit d5f8291

36 files changed

+285
-204
lines changed

‎contributing/code/bugs.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Whenever you find a bug in Symfony2, we kindly ask you to report it. It helps
55
us make a better Symfony2.
66

77
.. caution::
8-
If you think you've found a security issue, please use the special
9-
doc:`procedure <security>` instead.
8+
9+
If you think you've found a security issue, please use the special
10+
doc:`procedure <security>` instead.
1011

1112
Before submitting a bug:
1213

‎contributing/code/license.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Symfony2 is released under the MIT license.
55

66
According to `Wikipedia`_:
77

8-
"It is a permissive license, meaning that it permits reuse within
9-
proprietary software on the condition that the license is distributed with
10-
that software. The license is also GPL-compatible, meaning that the GPL
11-
permits combination and redistribution with software that uses the MIT
12-
License."
8+
"It is a permissive license, meaning that it permits reuse within
9+
proprietary software on the condition that the license is distributed with
10+
that software. The license is also GPL-compatible, meaning that the GPL
11+
permits combination and redistribution with software that uses the MIT
12+
License."
1313

1414
The License
1515
-----------

‎contributing/code/patches.rst

+13-9
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Set up your user information with your real name and a working email address:
2424
$ git config --global user.email you@example.com
2525
2626
.. tip::
27-
If you are new to Git, we highly recommend you to read the excellent and free
28-
`ProGit`_ book.
27+
28+
If you are new to Git, we highly recommend you to read the excellent and
29+
free `ProGit`_ book.
2930

3031
Get the Symfony2 code source:
3132

@@ -61,8 +62,9 @@ topic branch:
6162
$ git checkout -b BRANCH_NAME
6263
6364
.. tip::
64-
Use a descriptive name for your branch (`ticket_XXX` where `XXX` is the ticket
65-
number is a good convention for bug fixes).
65+
66+
Use a descriptive name for your branch (`ticket_XXX` where `XXX` is the
67+
ticket number is a good convention for bug fixes).
6668

6769
The above command automatically switches the code to the newly created branch
6870
(check the branch you are working on with `git branch`.)
@@ -82,11 +84,13 @@ in mind the following:
8284
* Write good commit messages.
8385

8486
.. tip::
85-
A good commit message is composed of a summary (the first line), optionally
86-
followed by a blank line and a more detailed description. The summary should
87-
start with the Component you are working on in square brackets
88-
(`[DependencyInjection]`, `[FrameworkBundle]`, ...). Use a verb (`fixed ...`,
89-
`added ...`, ...) to start the summary and don't add a period at the end.
87+
88+
A good commit message is composed of a summary (the first line), optionally
89+
followed by a blank line and a more detailed description. The summary
90+
should start with the Component you are working on in square brackets
91+
(`[DependencyInjection]`, `[FrameworkBundle]`, ...). Use a verb
92+
(`fixed ...`, `added ...`, ...) to start the summary and don't add a period
93+
at the end.
9094

9195
Submitting a Patch
9296
------------------

‎contributing/code/security.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ confirmed, the core-team works on a solution following these steps:
1717
5. Publish the post on the official Symfony blog.
1818

1919
.. note::
20-
While we are working on a patch, please do not reveal the issue publicly.
20+
21+
While we are working on a patch, please do not reveal the issue publicly.

‎contributing/code/tests.rst

+8-5
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ To install them all, run the `install_vendors.sh` script:
3939
$ sh install_vendors.sh
4040
4141
.. note::
42-
Note that the script takes some time to finish.
42+
43+
Note that the script takes some time to finish.
4344

4445
After installation, you can update the vendors anytime with the
4546
`update_vendors.sh` script:
@@ -64,8 +65,9 @@ The output should display `OK`. If not, you need to figure out what's going on
6465
and if the tests are broken because of your modifications.
6566

6667
.. tip::
67-
Run the test suite before applying your modifications to check that they run
68-
fine on your configuration.
68+
69+
Run the test suite before applying your modifications to check that they
70+
run fine on your configuration.
6971

7072
Code Coverage
7173
-------------
@@ -81,7 +83,8 @@ Check the code coverage by opening the generated `cov/index.html` page in a
8183
browser.
8284

8385
.. tip::
84-
The code coverage only works if you have XDebug enabled and all dependencies
85-
installed.
86+
87+
The code coverage only works if you have XDebug enabled and all
88+
dependencies installed.
8689

8790
.. _install: http://www.phpunit.de/manual/current/en/installation.html

‎contributing/documentation/format.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ the highlighted pseudo-language:
4949
<?php echo $this->foobar(); ?>
5050
5151
.. note::
52-
A list of supported languages is available on the `Pygments website`_.
52+
53+
A list of supported languages is available on the `Pygments website`_.
5354

5455
Configuration Blocks
5556
~~~~~~~~~~~~~~~~~~~~

‎contributing/documentation/overview.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ If you want to submit a patch, clone the official documentation repository:
2525
$ git clone git://github.com/symfony/symfony-docs.git
2626
2727
.. note::
28-
The Symfony2 documentation is licensed under a Creative Commons
29-
Attribution-Share Alike 3.0 Unported :doc:`License <license>`.
28+
29+
The Symfony2 documentation is licensed under a Creative Commons
30+
Attribution-Share Alike 3.0 Unported :doc:`License <license>`.
3031

3132
Reporting an Issue
3233
------------------

‎contributing/documentation/translations.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ for. Here is the list of the official *master* repositories:
2121
* *Romanian*: http://github.com/sebastian-ionescu/symfony-docs-ro
2222

2323
.. note::
24-
If you want to contribute translations for a new language, read the
25-
:ref:`dedicated section <translations-adding-a-new-language>`.
24+
25+
If you want to contribute translations for a new language, read the
26+
:ref:`dedicated section <translations-adding-a-new-language>`.
2627

2728
Joining the Translation Team
2829
----------------------------
@@ -76,7 +77,8 @@ reorganized, ...). The translation team need to closely follow the English
7677
repository and apply changes to the translated documents as soon as possible.
7778

7879
.. caution::
79-
Non maintained languages are removed from the official list of
80-
repositories as obsolete documentation is dangerous.
80+
81+
Non maintained languages are removed from the official list of
82+
repositories as obsolete documentation is dangerous.
8183

8284
.. _Symfony docs mailing-list: http://groups.google.com/group/symfony-docs

‎guides/bundles/best_practices.rst

+12-8
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ A bundle is also a PHP namespace, composed of several segments:
2525
* The **bundle name**.
2626

2727
.. caution::
28-
The vendor namespace and the category namespaces are only possible as of
29-
Symfony2 PR3.
28+
29+
The vendor namespace and the category namespaces are only possible as of
30+
Symfony2 PR3.
3031

3132
The bundle name must follow these simple rules:
3233

@@ -76,8 +77,9 @@ The following files are mandatory:
7677
* ``Resources/doc/index.rst``: The root file for the Bundle documentation.
7778

7879
.. note::
79-
These conventions ensure that automated tools can rely on this default
80-
structure to work.
80+
81+
These conventions ensure that automated tools can rely on this default
82+
structure to work.
8183

8284
The depth of sub-directories should be kept to the minimal for most used
8385
classes and files (2 levels at a maximum). More levels can be defined for
@@ -166,9 +168,10 @@ extend :class:`Symfony\\Foundation\\DependencyInjection\\ContainerAware`
166168
instead.
167169

168170
.. note::
171+
169172
If you have a look at :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller`
170-
methods, you will see that they are only nice shortcuts to ease the learning
171-
curve.
173+
methods, you will see that they are only nice shortcuts to ease the
174+
learning curve.
172175

173176
Templates
174177
---------
@@ -178,8 +181,9 @@ must not provide a main layout, but extend a default ``base`` template (which
178181
must provide two slots: ``content`` and ``head``).
179182

180183
.. note::
181-
The only other template engine supported is Twig, but only for specific
182-
cases.
184+
185+
The only other template engine supported is Twig, but only for specific
186+
cases.
183187

184188
Translation Files
185189
-----------------

‎guides/bundles/configuration.rst

+9-6
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,9 @@ configuration file:
140140
$container->loadFromExtension('hello', 'config', array());
141141
142142
.. note::
143-
You can create as many ``xxxLoad()`` methods as you want to define more
144-
configuration blocks for your extension.
143+
144+
You can create as many ``xxxLoad()`` methods as you want to define more
145+
configuration blocks for your extension.
145146

146147
Parsing a Configuration
147148
~~~~~~~~~~~~~~~~~~~~~~~
@@ -219,8 +220,9 @@ The global parameters are the following:
219220
* ``kernel.charset``
220221

221222
.. caution::
222-
All parameter and service names starting with a ``_`` are reserved for the
223-
framework, and new ones must not be defined by bundles.
223+
224+
All parameter and service names starting with a ``_`` are reserved for the
225+
framework, and new ones must not be defined by bundles.
224226

225227
.. index::
226228
pair: Convention; Configuration
@@ -282,5 +284,6 @@ method::
282284
}
283285

284286
.. caution::
285-
Symfony2 tries to be as explicit as possible. So, registering a default
286-
configuration automatically is probably not a good idea.
287+
288+
Symfony2 tries to be as explicit as possible. So, registering a default
289+
configuration automatically is probably not a good idea.

‎guides/doctrine/dbal/overview.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ sits on top of `PDO`_ and offers an intuitive and flexible API for
99
communicating with the most popular relational databases that exist today!
1010

1111
.. tip::
12-
You can read more about the Doctrine DBAL on the official `documentation`_
13-
website.
12+
13+
You can read more about the Doctrine DBAL on the official `documentation`_
14+
website.
1415

1516
To get started you just need to enable and configure the DBAL:
1617

‎guides/doctrine/migrations/overview.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ layer and offers you the ability to programmatically deploy new versions of
99
your database schema in a safe and standardized way.
1010

1111
.. tip::
12-
You can read more about the Doctrine Database Migrations on the projects
13-
`documentation`_.
12+
13+
You can read more about the Doctrine Database Migrations on the projects
14+
`documentation`_.
1415

1516
All of the migrations functionality is contained in a few console commands:
1617

‎guides/doctrine/mongodb-odm/overview.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ it works and architecture. You only deal with plain PHP objects and they are
99
persisted transparently without imposing on your domain model.
1010

1111
.. tip::
12-
You can read more about the Doctrine MongoDB Object Document Mapper on the
13-
projects `documentation`_.
12+
13+
You can read more about the Doctrine MongoDB Object Document Mapper on the
14+
projects `documentation`_.
1415

1516
To get started working with Doctrine and the MongoDB Object Document Mapper you
1617
just need to enable it:

‎guides/doctrine/orm/overview.rst

+12-9
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ powerful DataBase Abstraction Layer (DBAL). It provides transparent
99
persistence for PHP objects.
1010

1111
.. tip::
12-
You can read more about the Doctrine Object Relational Mapper on the
13-
official `documentation`_ website.
12+
13+
You can read more about the Doctrine Object Relational Mapper on the
14+
official `documentation`_ website.
1415

1516
To get started, enable and configure the :doc:`Doctrine DBAL
1617
</guides/doctrine/dbal/overview>`, then enable the ORM:
@@ -61,10 +62,11 @@ any PHP class::
6162
}
6263

6364
.. tip::
64-
When defining your entities, you can omit the getter/setter methods and
65-
let Doctrine create them for you with the ``doctrine:generate:entities``
66-
command. This only works after you create the mapping information (see
67-
below.)
65+
66+
When defining your entities, you can omit the getter/setter methods and
67+
let Doctrine create them for you with the ``doctrine:generate:entities``
68+
command. This only works after you create the mapping information (see
69+
below).
6870

6971
To let Doctrine manage your classes (entities in Doctrine2 speak), you need to
7072
write mapping information with annotations, XML, or YAML:
@@ -128,9 +130,10 @@ write mapping information with annotations, XML, or YAML:
128130
</doctrine-mapping>
129131
130132
.. note::
131-
If you use YAML or XML to describe your entities, you can omit the creation
132-
of the Entity class, and let the ``doctrine:generate:entities`` command do
133-
it for you.
133+
134+
If you use YAML or XML to describe your entities, you can omit the creation
135+
of the Entity class, and let the ``doctrine:generate:entities`` command do
136+
it for you.
134137

135138
Create the database and the schema related to your metadata information with
136139
the following commands:

‎guides/emails.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,9 @@ The mailer is accessible via the ``mailer`` service; from an action::
104104
}
105105

106106
.. note::
107-
To keep things decoupled, the email body has been stored in a template,
108-
rendered with the ``renderView()`` method.
107+
108+
To keep things decoupled, the email body has been stored in a template,
109+
rendered with the ``renderView()`` method.
109110

110111
Using Gmail
111112
-----------

‎guides/event/overview.rst

+16-12
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ Here are some examples of good event names:
5050
* response.filter_content
5151

5252
.. note::
53-
You can of course extend the ``Event`` class to specialize an event further,
54-
or enforce some constraints, but most of the time it adds an unnecessary
55-
level of complexity.
53+
54+
You can of course extend the ``Event`` class to specialize an event
55+
further, or enforce some constraints, but most of the time it adds an
56+
unnecessary level of complexity.
5657

5758
Besides its name, an ``Event`` instance can store additional data about the
5859
notified event:
@@ -111,24 +112,27 @@ The ``connect()`` method takes two arguments:
111112
* A PHP callable to call when the event is notified.
112113

113114
.. note::
114-
A `PHP callable`_ is a PHP variable that can be used by the
115-
``call_user_func()`` function and returns ``true`` when passed to the
116-
``is_callable()`` function. It can be a ``\Closure`` instance, a string
117-
representing a function, or an array representing an object method or a
118-
class method.
115+
116+
A `PHP callable`_ is a PHP variable that can be used by the
117+
``call_user_func()`` function and returns ``true`` when passed to the
118+
``is_callable()`` function. It can be a ``\Closure`` instance, a string
119+
representing a function, or an array representing an object method or a
120+
class method.
119121

120122
Once a listener is registered with the dispatcher, it waits until the event is
121123
notified. For the above example, the dispatcher calls ``$callable`` whenever
122124
the ``user.change_culture`` event is notified; the listener receives an
123125
``Event`` instance as an argument.
124126

125127
.. note::
126-
The listeners are called by the event dispatcher in the same order you
127-
connected them.
128+
129+
The listeners are called by the event dispatcher in the same order you
130+
connected them.
128131

129132
.. tip::
130-
If you use the Symfony2 MVC framework, listeners are automatically
131-
registered based on your :ref:`configuration <kernel_listener_tag>`.
133+
134+
If you use the Symfony2 MVC framework, listeners are automatically
135+
registered based on your :ref:`configuration <kernel_listener_tag>`.
132136

133137
.. index::
134138
single: Event Dispatcher; Notification

‎guides/event/recipes.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ time. But when you have a long list of dependencies, using setter injection
4646
can be the way to go, especially for optional dependencies.
4747

4848
.. tip::
49-
If you use dependency injection like we did in the two examples above, you
50-
can then easily use the Symfony2 Dependency Injection component to elegantly
51-
manage these objects.
49+
50+
If you use dependency injection like we did in the two examples above, you
51+
can then easily use the Symfony2 Dependency Injection component to
52+
elegantly manage these objects.
5253

5354
Doing something before or after a Method Call
5455
---------------------------------------------

0 commit comments

Comments
 (0)