Skip to content

Commit c0637b6

Browse files
committed
Implemented the changes suggested by reviewers
1 parent 3dd40b2 commit c0637b6

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

cookbook/bundles/best_practices.rst

+6
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,12 @@ following standardized instructions in your ``README.md`` file.
303303
304304
.. _`installation chapter`: https://getcomposer.org/doc/00-intro.md
305305
306+
The example above assumes that you are installing the latest stable version of
307+
the bundle, where you don't have to provide the package version number
308+
(e.g. ``composer require friendsofsymfony/user-bundle``). If the installation
309+
instructions refer to some past bundle version or to some inestable version,
310+
include the version constraint (e.g. ``composer require friendsofsymfony/user-bundle "~2.0@dev"``).
311+
306312
Optionally, you can add more installation steps (*Step 3*, *Step 4*, etc.) to
307313
explain other required installation tasks, such as registering routes or
308314
dumping assets.

cookbook/bundles/installation.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
6363
public function registerBundles()
6464
{
6565
$bundles = array(
66-
// ...,
66+
// ...
6767
new FOS\UserBundle\FOSUserBundle(),
6868
);
6969

@@ -73,8 +73,9 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
7373

7474
By default, Symfony bundles are registered in all the application
7575
:doc:`execution environments </cookbook/configuration/environments>`. If the bundle
76-
is meant to be used only in the development or test environments, register it in
77-
the section below::
76+
is meant to be used only in some environment, register it within an ``if`` statement,
77+
like the following example, where the FOSUserBundle is only enabled for the
78+
``dev`` and ``test`` environments::
7879

7980
// app/AppKernel.php
8081

@@ -86,7 +87,7 @@ the section below::
8687
public function registerBundles()
8788
{
8889
$bundles = array(
89-
// ...,
90+
// ...
9091
);
9192

9293
if (in_array($this->getEnvironment(), array('dev', 'test'))) {

0 commit comments

Comments
 (0)