Skip to content

Typos #3224

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

Merged
merged 1 commit into from
Dec 23, 2013
Merged

Typos #3224

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
6 changes: 3 additions & 3 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Contributing

>**Note**
>Unless you're documenting a feature that's new to a specific version of Symfony
>(e.g. Symfony 2.3), all pull requests must be based off of the **2.2** branch,
>(e.g. Symfony 2.3), all pull requests must be based off of the **2.2** branch,
>**not** the master or 2.3 branch.

We love contributors! For more information on how you can contribute to the
Symfony documentation, please read
[Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
Symfony documentation, please read
[Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
2 changes: 1 addition & 1 deletion book/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1166,7 +1166,7 @@ form with many ``Product`` sub-forms). This is done by using the ``collection``
field type.

For more information see the ":doc:`/cookbook/form/form_collections`" cookbook
entry and the :doc:`collection </reference/forms/types/collection>` field type reference.
entry and the :doc:`collection </reference/forms/types/collection>` field type reference.

.. index::
single: Forms; Theming
Expand Down
2 changes: 1 addition & 1 deletion book/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Updating Vendors

At this point, you've downloaded a fully-functional Symfony project in which
you'll start to develop your own application. A Symfony project depends on
a number of external libraries. These are downloaded into the `vendor/` directory
a number of external libraries. These are downloaded into the ``vendor/`` directory
of your project via a library called `Composer`_.

Depending on how you downloaded Symfony, you may or may not need to update
Expand Down
8 changes: 4 additions & 4 deletions book/page_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ also load specific bundles based on the selected environment. For example,
Symfony2 comes with the WebProfilerBundle (described below), enabled only
in the ``dev`` and ``test`` environments.

Symfony2 comes with two web-accessible front controllers: ``app_dev.php``
Symfony2 comes with two web-accessible front controllers: ``app_dev.php``
provides the ``dev`` environment, and ``app.php`` provides the ``prod`` environment.
All web accesses to Symfony2 normally go through one of these front controllers.
(The ``test`` environment is normally only used when running unit tests, and so
(The ``test`` environment is normally only used when running unit tests, and so
doesn't have a dedicated front controller. The console tool also provides a
front controller that can be used with any environment.)

Expand Down Expand Up @@ -555,7 +555,7 @@ You'll learn more about each of these directories in later chapters.

When Symfony is loading, a special file - ``vendor/autoload.php`` - is
included. This file is created by Composer and will autoload all
application files living in the `src/` folder as well as all
application files living in the ``src/`` folder as well as all
third-party libraries mentioned in the ``composer.json`` file.

Because of the autoloader, you never need to worry about using ``include``
Expand Down Expand Up @@ -868,7 +868,7 @@ Default Configuration Dump
The ``config:dump-reference`` command was added in Symfony 2.1

You can dump the default configuration for a bundle in YAML to the console using
the ``config:dump-reference`` command. Here is an example of dumping the default
the ``config:dump-reference`` command. Here is an example of dumping the default
FrameworkBundle configuration:

.. code-block:: text
Expand Down
8 changes: 4 additions & 4 deletions book/propel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Creating the Database Tables/Schema
Now you have a usable ``Product`` class and all you need to persist it. Of
course, you don't yet have the corresponding ``product`` table in your
database. Fortunately, Propel can automatically create all the database tables
needed for every known model in your application. To do this, run:
needed for every known model in your application. To do this, run:

.. code-block:: bash

Expand All @@ -153,7 +153,7 @@ Persisting Objects to the Database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Now that you have a ``Product`` object and corresponding ``product`` table,
you're ready to persist data to the database. From inside a controller, this
you're ready to persist data to the database. From inside a controller, this
is pretty easy. Add the following method to the ``DefaultController`` of the
bundle::

Expand Down Expand Up @@ -406,7 +406,7 @@ Fetching Related Objects
~~~~~~~~~~~~~~~~~~~~~~~~

When you need to fetch associated objects, your workflow looks just like it did
before. First, fetch a ``$product`` object and then access its related
before. First, fetch a ``$product`` object and then access its related
``Category``::

// ...
Expand Down Expand Up @@ -435,7 +435,7 @@ Lifecycle Callbacks
-------------------

Sometimes, you need to perform an action right before or after an object is
inserted, updated, or deleted. These types of actions are known as "lifecycle"
inserted, updated, or deleted. These types of actions are known as "lifecycle"
callbacks or "hooks", as they're callback methods that you need to execute
during different stages of the lifecycle of an object (e.g. the object is
inserted, updated, deleted, etc).
Expand Down
2 changes: 1 addition & 1 deletion book/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,7 @@ Global Template Variables
-------------------------

During each request, Symfony2 will set a global template variable ``app``
in both Twig and PHP template engines by default. The ``app`` variable
in both Twig and PHP template engines by default. The ``app`` variable
is a :class:`Symfony\\Bundle\\FrameworkBundle\\Templating\\GlobalVariables`
instance which will give you access to some application specific variables
automatically:
Expand Down
2 changes: 1 addition & 1 deletion book/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ Redirecting

When a request returns a redirect response, the client does not follow
it automatically. You can examine the response and force a redirection
afterwards with the ``followRedirect()`` method::
afterwards with the ``followRedirect()`` method::

$crawler = $client->followRedirect();

Expand Down
2 changes: 1 addition & 1 deletion book/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ You could also pass the collection of errors into a template.
return $this->render('AcmeBlogBundle:Author:validate.html.twig', array(
'errors' => $errors,
));
}
}

Inside the template, you can output the list of errors exactly as needed:

Expand Down
4 changes: 2 additions & 2 deletions components/class_loader/cache_class_loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ for a class.

.. note::

Both the ``ApcClassLoader`` and the ``XcacheClassLoader`` can be used
to cache Composer's `autoloader`_.
Both the ``ApcClassLoader`` and the ``XcacheClassLoader`` can be used
to cache Composer's `autoloader`_.

ApcClassLoader
--------------
Expand Down
2 changes: 1 addition & 1 deletion components/class_loader/class_loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ or one of its children, the autoloader will first look for the class under the
of the prefix registrations is significant in this case.

.. _PEAR: http://pear.php.net/manual/en/standards.naming.php
.. _PSR-0: http://symfony.com/PSR0
.. _PSR-0: http://www.php-fig.org/psr/psr-0/
2 changes: 1 addition & 1 deletion components/class_loader/map_class_loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ an instance of the ``MapClassLoader`` class::

$loader->register();

.. _PSR-0: http://symfony.com/PSR0
.. _PSR-0: http://www.php-fig.org/psr/psr-0/
2 changes: 1 addition & 1 deletion components/dependency_injection/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Constants as Parameters
-----------------------

The container also has support for setting PHP constants as parameters. To
take advantage of this feature, map the name of your constant to a parameter
take advantage of this feature, map the name of your constant to a parameter
key, and define the type as ``constant``.

.. configuration-block::
Expand Down
4 changes: 2 additions & 2 deletions components/event_dispatcher/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ EventDispatcher aware Events and Listeners
The ``Event`` object contains a reference to the invoking dispatcher since Symfony 2.1

The ``EventDispatcher`` always injects a reference to itself in the passed event
object. This means that all listeners have direct access to the
object. This means that all listeners have direct access to the
``EventDispatcher`` object that notified the listener via the passed ``Event``
object's :method:`Symfony\\Component\\EventDispatcher\\Event::getDispatcher`
method.
Expand Down Expand Up @@ -492,7 +492,7 @@ Dispatching another event from within a listener::

While this above is sufficient for most uses, if your application uses multiple
``EventDispatcher`` instances, you might need to specifically inject a known
instance of the ``EventDispatcher`` into your listeners. This could be done
instance of the ``EventDispatcher`` into your listeners. This could be done
using constructor or setter injection as follows:

Constructor injection::
Expand Down
4 changes: 2 additions & 2 deletions components/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Exists
~~~~~~

:method:`Symfony\\Component\\Filesystem\\Filesystem::exists` checks for the
presence of all files or directories and returns false if a file is missing::
presence of all files or directories and returns ``false`` if a file is missing::

// this directory exists, return true
$fs->exists('/tmp/photos');
Expand Down Expand Up @@ -222,7 +222,7 @@ isAbsolutePath
~~~~~~~~~~~~~~

:method:`Symfony\\Component\\Filesystem\\Filesystem::isAbsolutePath` returns
``true`` if the given path is absolute, false otherwise::
``true`` if the given path is absolute, ``false`` otherwise::

// return true
$fs->isAbsolutePath('/tmp');
Expand Down
4 changes: 2 additions & 2 deletions components/finder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ Restrict files by last modified dates with the

$finder->date('since yesterday');

The comparison operator can be any of the following: ``>``, ``>=``, ``<``, '<=',
'=='. You can also use ``since`` or ``after`` as an alias for ``>``, and
The comparison operator can be any of the following: ``>``, ``>=``, ``<``, ``<=``,
``==``. You can also use ``since`` or ``after`` as an alias for ``>``, and
``until`` or ``before`` as an alias for ``<``.

The target value can be any date supported by the `strtotime`_ function.
Expand Down
4 changes: 2 additions & 2 deletions components/http_foundation/session_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ store and retrieve session data, and configuring session behaviour.
Save Handlers
~~~~~~~~~~~~~

The PHP session workflow has 6 possible operations that may occur. The normal
The PHP session workflow has 6 possible operations that may occur. The normal
session follows `open`, `read`, `write` and `close`, with the possibility of
`destroy` and `gc` (garbage collection which will expire any old sessions: `gc`
is called randomly according to PHP's configuration and if called, it is invoked
after the `open` operation). You can read more about this at
after the `open` operation). You can read more about this at
`php.net/session.customhandler`_

Native PHP Save Handlers
Expand Down
2 changes: 1 addition & 1 deletion components/http_foundation/sessions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ has a simple API
Adds a flash message to the stack of specified type;

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Flash\\FlashBagInterface::set`:
Sets flashes by type; This method conveniently takes both singles messages as
Sets flashes by type; This method conveniently takes both singles messages as
a ``string`` or multiple messages in an ``array``.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Flash\\FlashBagInterface::get`:
Expand Down
2 changes: 1 addition & 1 deletion components/http_kernel/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ The only requirement is that it is a PHP callable - i.e. a function, method
on an object, or a ``Closure``.

But *how* you determine the exact controller for a request is entirely up
to your application. This is the job of the "controller resolver" - a class
to your application. This is the job of the "controller resolver" - a class
that implements :class:`Symfony\\Component\\HttpKernel\\Controller\\ControllerResolverInterface`
and is one of the constructor arguments to ``HttpKernel``.

Expand Down
2 changes: 1 addition & 1 deletion components/routing/hostname_pattern.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ instance, if you want to match both ``m.example.com`` and
mobile_homepage:
path: /
host: "{subdomain}.example.com"
defaults:
defaults:
_controller: AcmeDemoBundle:Main:mobileHomepage
subdomain: m
requirements:
Expand Down
2 changes: 1 addition & 1 deletion components/routing/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ placeholders as regular expressions.
4. An array of options. These contain internal settings for the route and
are the least commonly needed.

5. A host. This is matched against the host of the request. See
5. A host. This is matched against the host of the request. See
:doc:`/components/routing/hostname_pattern` for more details.

6. An array of schemes. These enforce a certain HTTP scheme (``http``, ``https``).
Expand Down
6 changes: 3 additions & 3 deletions contributing/code/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ License
* Symfony is released under the MIT license, and the license block has to be
present at the top of every PHP file, before the namespace.

.. _`PSR-0`: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
.. _`PSR-1`: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
.. _`PSR-2`: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
.. _`PSR-0`: http://www.php-fig.org/psr/psr-0/
.. _`PSR-1`: http://www.php-fig.org/psr/psr-1/
.. _`PSR-2`: http://www.php-fig.org/psr/psr-2/
1 change: 0 additions & 1 deletion contributing/community/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,5 +161,4 @@ upgrade.

.. _Git repository: https://github.com/symfony/symfony
.. _SensioLabs: http://sensiolabs.com/
.. _roadmap: http://symfony.com/roadmap
.. _`timeline calculator`: http://symfony.com/roadmap
4 changes: 2 additions & 2 deletions cookbook/assetic/apply_to_option.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ An example configuration might look like this:

<!-- app/config/config.xml -->
<assetic:config>
<assetic:filter
<assetic:filter
name="coffee"
bin="/usr/bin/coffee/"
node="/usr/bin/node/">
Expand Down Expand Up @@ -72,7 +72,7 @@ templates:
<script src="<?php echo $view->escape($url) ?>" type="text/javascript"></script>
<?php endforeach; ?>

This is all that's needed to compile this CoffeeScript file and server it
This is all that's needed to compile this CoffeeScript file and serve it
as the compiled JavaScript.

Filter Multiple Files
Expand Down
2 changes: 1 addition & 1 deletion cookbook/assetic/asset_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ In fact, Assetic has a long list of available filters.

Many of the filters do not do the work directly, but use existing third-party
libraries to do the heavy-lifting. This means that you'll often need to install
a third-party library to use a filter. The great advantage of using Assetic
a third-party library to use a filter. The great advantage of using Assetic
to invoke these libraries (as opposed to using them directly) is that instead
of having to run them manually after you work on the files, Assetic will
take care of this for you and remove this step altogether from your development
Expand Down
2 changes: 1 addition & 1 deletion cookbook/bundles/best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -284,4 +284,4 @@ Learn more from the Cookbook

* :doc:`/cookbook/bundles/extension`

.. _standards: http://symfony.com/PSR0
.. _standards: http://www.php-fig.org/psr/psr-0/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabpot It looks like the PSR0 link at symfony.com is now broken (you added it way back at sha: 019302f). We can change back, but I'm guessing you'd rather fix this :).

Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see a reason why symfony should have a PSR0 page?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, turns out it was just redirecting to the PSR-0 standard: http://web.archive.org/web/20130814171407/http://symfony.com/PSR0

I don't see any reason to use it in our docs, instead of the official github link.

4 changes: 2 additions & 2 deletions cookbook/bundles/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ When you create a bundle, you have two choices on how to handle configuration:
The second option - which you'll learn about in this article - is much more
flexible, but also requires more time to setup. If you're wondering which
method you should use, it's probably a good idea to start with method #1,
and then change to #2 later if you need to. If you plan to distribute your
and then change to #2 later if you need to. If you plan to distribute your
bundle, the second option is recommended.

The second method has several specific advantages:
Expand Down Expand Up @@ -519,7 +519,7 @@ be output to the console in YAML.

As long as your bundle's configuration is located in the standard location
(``YourBundle\DependencyInjection\Configuration``) and does not have a
``__construct()`` it will work automatically. If you have something
``__construct()`` it will work automatically. If you have something
different, your ``Extension`` class must override the
:method:`Extension::getConfiguration() <Symfony\\Component\\HttpKernel\\DependencyInjection\\Extension::getConfiguration>`
method and return an instance of your
Expand Down
4 changes: 2 additions & 2 deletions cookbook/bundles/remove.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ the name of the bundle is, e.g. ``fos_user`` for the FOSUserBundle) string in
the configuration files.

The AcmeDemoBundle doesn't have configuration. However, the bundle is
used in the configuration for the ``app/config/security.yml`` file. You can
used in the configuration for the ``app/config/security.yml`` file. You can
use it as a boilerplate for your own security, but you **can** also remove
everything: it doesn't matter to Symfony if you remove it or not.

Expand Down Expand Up @@ -103,4 +103,4 @@ rely on the bundle you are about to remove.
.. tip::

If a third party bundle relies on another bundle, you can find that bundle
mentioned in the ``composer.json`` file included in the bundle directory.
mentioned in the ``composer.json`` file included in the bundle directory.
2 changes: 1 addition & 1 deletion cookbook/configuration/environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ multiple environments in an elegant, powerful and transparent way.

Of course, in reality, each environment differs only somewhat from others.
Generally, all environments will share a large base of common configuration.
Opening the "dev" configuration file, you can see how this is accomplished
Opening the "dev" configuration file, you can see how this is accomplished
easily and transparently:

.. configuration-block::
Expand Down
4 changes: 2 additions & 2 deletions cookbook/configuration/external_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Environment Variables
---------------------

Symfony will grab any environment variable prefixed with ``SYMFONY__`` and
set it as a parameter in the service container. Double underscores are replaced
set it as a parameter in the service container. Double underscores are replaced
with a period, as a period is not a valid character in an environment variable
name.

Expand All @@ -39,7 +39,7 @@ the following ``VirtualHost`` configuration:
.. note::

The example above is for an Apache configuration, using the `SetEnv`_
directive. However, this will work for any web server which supports
directive. However, this will work for any web server which supports
the setting of environment variables.

Also, in order for your console to work (which does not use Apache),
Expand Down
2 changes: 1 addition & 1 deletion cookbook/configuration/front_controllers_and_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Understanding how the Front Controller, Kernel and Environments work together

The section :doc:`/cookbook/configuration/environments` explained the basics
on how Symfony uses environments to run your application with different configuration
settings. This section will explain a bit more in-depth what happens when
settings. This section will explain a bit more in-depth what happens when
your application is bootstrapped. To hook into this process, you need to understand
three parts that work together:

Expand Down
2 changes: 1 addition & 1 deletion cookbook/configuration/web_server_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ following configuration snippet:

.. code-block:: apache

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

.. caution::

Expand Down
3 changes: 1 addition & 2 deletions cookbook/console/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ container and use it to do the logging::
if ($input->getOption('yell')) {
$text = strtoupper($text);
$logger->warn('Yelled: '.$text);
}
else {
} else {
$logger->info('Greeted: '.$text);
}

Expand Down
Loading