8000 Implemented the changes suggested by reviewers · symfony/symfony-docs@527e0fc · GitHub
[go: up one dir, main page]

Skip to content
Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 527e0fc

Browse files
committed
Implemented the changes suggested by reviewers
1 parent 1a46e2f commit 527e0fc

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

cookbook/bundles/best_practices.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,12 @@ following standardized instructions in your ``README.md`` file.
253253
}
254254
```
255255
256+
The example above assumes that you are installing the latest stable version of
257+
the bundle, where you don't have to provide the package version number
258+
(e.g. ``composer require friendsofsymfony/user-bundle``). If the installation
259+
instructions refer to some past bundle version or to some inestable version,
260+
include the version constraint (e.g. ``composer require friendsofsymfony/user-bundle "~2.0@dev"``).
261+
256262
Optionally, you can add more installation steps (*Step 3*, *Step 4*, etc.) to
257263
explain other required installation tasks, such as registering routes or
258264
dumping assets.

cookbook/bundles/installation.rst

Lines changed: 5 additions & 4 deletions
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 FOSUserBu 8CD8 ndle 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)
0