Skip to content

Fix documentation style on directives and parenthesis typo #53

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 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions contributing/code/bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ Whenever you find a bug in Symfony2, we kindly ask you to report it. It helps
us make a better Symfony2.

.. caution::
If you think you've found a security issue, please use the special
doc:`procedure <security>` instead.

If you think you've found a security issue, please use the special
doc:`procedure <security>` instead.

Before submitting a bug:

Expand Down
10 changes: 5 additions & 5 deletions contributing/code/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Symfony2 is released under the MIT license.

According to `Uncyclopedia`_:

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

The License
-----------
Expand Down
24 changes: 14 additions & 10 deletions contributing/code/patches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ Set up your user information with your real name and a working email address:
$ git config --global user.email [email protected]

.. tip::
If you are new to Git, we highly recommend you to read the excellent and free
`ProGit`_ book.

If you are new to Git, we highly recommend you to read the excellent and
free `ProGit`_ book.

Get the Symfony2 code source:

Expand Down Expand Up @@ -61,11 +62,12 @@ topic branch:
$ git checkout -b BRANCH_NAME

.. tip::
Use a descriptive name for your branch (`ticket_XXX` where `XXX` is the ticket
number is a good convention for bug fixes).

Use a descriptive name for your branch (`ticket_XXX` where `XXX` is the
ticket number is a good convention for bug fixes).

The above command automatically switches the code to the newly created branch
(check the branch you are working on with `git branch`.)
(check the branch you are working on with `git branch`).

Work on the code as much as you want and commit as much as you want; but keep
in mind the following:
Expand All @@ -82,11 +84,13 @@ in mind the following:
* Write good commit messages.

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

A good commit message is composed of a summary (the first line), optionally
followed by a blank line and a more detailed description. The summary
should start with the Component you are working on in square brackets
(`[DependencyInjection]`, `[FrameworkBundle]`, ...). Use a verb
(`fixed ...`, `added ...`, ...) to start the summary and don't add a period
at the end.

Submitting a Patch
------------------
Expand Down
3 changes: 2 additions & 1 deletion contributing/code/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ confirmed, the core-team works on a solution following these steps:
5. Publish the post on the official Symfony blog.

.. note::
While we are working on a patch, please do not reveal the issue publicly.

While we are working on a patch, please do not reveal the issue publicly.
13 changes: 8 additions & 5 deletions contributing/code/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ To install them all, run the `install_vendors.sh` script:
$ sh install_vendors.sh

.. note::
Note that the script takes some time to finish.

Note that the script takes some time to finish.

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

.. tip::
Run the test suite before applying your modifications to check that they run
fine on your configuration.

Run the test suite before applying your modifications to check that they
run fine on your configuration.

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

.. tip::
The code coverage only works if you have XDebug enabled and all dependencies
installed.

The code coverage only works if you have XDebug enabled and all
dependencies installed.

.. _install: http://www.phpunit.de/manual/current/en/installation.html
3 changes: 2 additions & 1 deletion contributing/documentation/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ the highlighted pseudo-language:
<?php echo $this->foobar(); ?>

.. note::
A list of supported languages is available on the `Pygments website`_.

A list of supported languages is available on the `Pygments website`_.

Configuration Blocks
~~~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 3 additions & 2 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ If you want to submit a patch, clone the official documentation repository:
$ git clone git://github.com/symfony/symfony-docs.git

.. note::
The Symfony2 documentation is licensed under a Creative Commons
Attribution-Share Alike 3.0 Unported :doc:`License <license>`.

The Symfony2 documentation is licensed under a Creative Commons
Attribution-Share Alike 3.0 Unported :doc:`License <license>`.

Reporting an Issue
------------------
Expand Down
10 changes: 6 additions & 4 deletions contributing/documentation/translations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ for. Here is the list of the official *master* repositories:
* *Romanian*: http://github.com/sebastian-ionescu/symfony-docs-ro

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

If you want to contribute translations for a new language, read the
:ref:`dedicated section <translations-adding-a-new-language>`.

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

.. caution::
Non maintained languages are removed from the official list of
repositories as obsolete documentation is dangerous.

Non maintained languages are removed from the official list of
repositories as obsolete documentation is dangerous.

.. _Symfony docs mailing-list: http://groups.google.com/group/symfony-docs
20 changes: 12 additions & 8 deletions guides/bundles/best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ A bundle is also a PHP namespace, composed of several segments:
* The **bundle name**.

.. caution::
The vendor namespace and the category namespaces are only possible as of
Symfony2 PR3.

The vendor namespace and the category namespaces are only possible as of
Symfony2 PR3.

The bundle name must follow these simple rules:

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

.. note::
These conventions ensure that automated tools can rely on this default
structure to work.

These conventions ensure that automated tools can rely on this default
structure to work.

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

.. note::

If you have a look at :class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller`
methods, you will see that they are only nice shortcuts to ease the learning
curve.
methods, you will see that they are only nice shortcuts to ease the
learning curve.

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

.. note::
The only other template engine supported is Twig, but only for specific
cases.

The only other template engine supported is Twig, but only for specific
cases.

Translation Files
-----------------
Expand Down
15 changes: 9 additions & 6 deletions guides/bundles/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,9 @@ configuration file:
$container->loadFromExtension('hello', 'config', array());

.. note::
You can create as many ``xxxLoad()`` methods as you want to define more
configuration blocks for your extension.

You can create as many ``xxxLoad()`` methods as you want to define more
configuration blocks for your extension.

Parsing a Configuration
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -219,8 +220,9 @@ The global parameters are the following:
* ``kernel.charset``

.. caution::
All parameter and service names starting with a ``_`` are reserved for the
framework, and new ones must not be defined by bundles.

All parameter and service names starting with a ``_`` are reserved for the
framework, and new ones must not be defined by bundles.

.. index::
pair: Convention; Configuration
Expand Down Expand Up @@ -282,5 +284,6 @@ method::
}

.. caution::
Symfony2 tries to be as explicit as possible. So, registering a default
configuration automatically is probably not a good idea.

Symfony2 tries to be as explicit as possible. So, registering a default
configuration automatically is probably not a good idea.
8 changes: 4 additions & 4 deletions guides/cache/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ header when none is set by the developer by following these rules:

* But if at least one ``Cache-Control`` directive is set, and no 'public' or
``private`` directives have been explicitly added, Symfony2 adds the
``private`` directive automatically (except when ``s-maxage`` is set.)
``private`` directive automatically (except when ``s-maxage`` is set).

.. tip::

Expand Down Expand Up @@ -232,7 +232,7 @@ issue. Under this model, you mainly save bandwidth as the representation is
not sent twice to the same client (a 304 response is sent instead). But if you
design your application carefully, you might be able to get the bare minimum
data needed to send a 304 response and save CPU also; and if needed, perform
the more heavy tasks (see below for an implementation example.)
the more heavy tasks (see below for an implementation example).

.. index::
single: Cache; Etag header
Expand Down Expand Up @@ -399,7 +399,7 @@ Public vs Private Responses

As explained at the beginning of this document, Symfony2 is very conservative
and makes all Responses private by default (the exact rules are described
there.)
there).

If you want to use a shared cache, you must remember to explicitly add the
``public`` directive to ``Cache-Control``::
Expand Down Expand Up @@ -619,7 +619,7 @@ standalone is ``false``.

Symfony2 detects if a gateway cache supports ESI via another Akamaï
specification that is supported out of the box by the Symfony2 reverse
proxy (a working configuration for Varnish is also provided below.)
proxy (a working configuration for Varnish is also provided below).

For the ESI include tag to work properly, you must define the ``_internal``
route:
Expand Down
5 changes: 3 additions & 2 deletions guides/doctrine/dbal/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ sits on top of `PDO`_ and offers an intuitive and flexible API for
communicating with the most popular relational databases that exist today!

.. tip::
You can read more about the Doctrine DBAL on the official `documentation`_
website.

You can read more about the Doctrine DBAL on the official `documentation`_
website.

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

Expand Down
5 changes: 3 additions & 2 deletions guides/doctrine/migrations/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ layer and offers you the ability to programmatically deploy new versions of
your database schema in a safe and standardized way.

.. tip::
You can read more about the Doctrine Database Migrations on the projects
`documentation`_.

You can read more about the Doctrine Database Migrations on the projects
`documentation`_.

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

Expand Down
5 changes: 3 additions & 2 deletions guides/doctrine/mongodb-odm/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ it works and architecture. You only deal with plain PHP objects and they are
persisted transparently without imposing on your domain model.

.. tip::
You can read more about the Doctrine MongoDB Object Document Mapper on the
projects `documentation`_.

You can read more about the Doctrine MongoDB Object Document Mapper on the
projects `documentation`_.

To get started working with Doctrine and the MongoDB Object Document Mapper you
just need to enable it:
Expand Down
21 changes: 12 additions & 9 deletions guides/doctrine/orm/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ powerful DataBase Abstraction Layer (DBAL). It provides transparent
persistence for PHP objects.

.. tip::
You can read more about the Doctrine Object Relational Mapper on the
official `documentation`_ website.

You can read more about the Doctrine Object Relational Mapper on the
official `documentation`_ website.

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

.. tip::
When defining your entities, you can omit the getter/setter methods and
let Doctrine create them for you with the ``doctrine:generate:entities``
command. This only works after you create the mapping information (see
below.)

When defining your entities, you can omit the getter/setter methods and
let Doctrine create them for you with the ``doctrine:generate:entities``
command. This only works after you create the mapping information (see
below).

To let Doctrine manage your classes (entities in Doctrine2 speak), you need to
write mapping information with annotations, XML, or YAML:
Expand Down Expand Up @@ -128,9 +130,10 @@ write mapping information with annotations, XML, or YAML:
</doctrine-mapping>

.. note::
If you use YAML or XML to describe your entities, you can omit the creation
of the Entity class, and let the ``doctrine:generate:entities`` command do
it for you.

If you use YAML or XML to describe your entities, you can omit the creation
of the Entity class, and let the ``doctrine:generate:entities`` command do
it for you.

Create the database and the schema related to your metadata information with
the following commands:
Expand Down
5 changes: 3 additions & 2 deletions guides/emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,9 @@ The mailer is accessible via the ``mailer`` service; from an action::
}

.. note::
To keep things decoupled, the email body has been stored in a template,
rendered with the ``renderView()`` method.

To keep things decoupled, the email body has been stored in a template,
rendered with the ``renderView()`` method.

Using Gmail
-----------
Expand Down
Loading