Skip to content
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

Reviewed the Bundles cookbook articles #5095

Merged
merged 5 commits into from
Jun 9, 2015

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets -

@@ -68,22 +71,46 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
}
}

By default, Symfony bundles are registered in all the application
:doc:`execution environments <cookbook/configuration/environments>`. If the bundle
Copy link
Member

Choose a reason for hiding this comment

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

missing the leading slash here

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed. Thanks.

A test suite must not contain ``AllTests.php`` scripts, but must rely on the
existence of a ``phpunit.xml.dist`` file.

Documentation
-------------

All classes and functions must come with full PHPDoc.
All classes and functions must be fully documented using `phpDocumentor`_ tags.
Copy link
Member

Choose a reason for hiding this comment

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

why phpDocumentor if Symfony relies on Sami and other PHPdoc generators are popular too?

@javiereguiluz javiereguiluz force-pushed the update_bundles_cookbook branch from b2cb6f1 to 82b6921 Compare May 23, 2015 08:25
@javiereguiluz
Copy link
Member Author

I've just fixed the conflicts of this PR. I think it's ready to be merged, because Wouter's concerns are taken into account (the first example removes the version number because of how we explain things and there is a note explaining that ... the second example shows a @dev version as an example of using advanced version constraints, so it's not unsafe to do that).

@javiereguiluz javiereguiluz force-pushed the update_bundles_cookbook branch from 588bac0 to 8008ac6 Compare May 29, 2015 07:21
@javiereguiluz
Copy link
Member Author

I've made all the proposed changes and I've fixed all the conflicts. Please, review it for the last time, label it as finished and consider merging it. Thanks.

@xabbuh
Copy link
Member

xabbuh commented May 30, 2015

👍

@weaverryan weaverryan merged commit 8008ac6 into symfony:2.3 Jun 9, 2015
weaverryan added a commit that referenced this pull request Jun 9, 2015
This PR was merged into the 2.3 branch.

Discussion
----------

Reviewed the Bundles cookbook articles

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | -

Commits
-------

8008ac6 Implemented the suggestions made by Christian and Wouter
8861215 Replace phpDocumentor by the standard PHPDoc
c0637b6 Implemented the changes suggested by reviewers
3dd40b2 Fixed an internal link reference
8254761 Reviewed the Bundles cookbook articles
@weaverryan
Copy link
Member

Thanks Javier! Minor tweaks at sha: ae35338

weaverryan added a commit that referenced this pull request Jun 19, 2015
* 2.3:
  [#5373] Small tweak per Stof's comment
  Fixed a minor grammar issue
  Fixed typos
  Link to the official repository of the bundle.
  Added mentions to some popular (and useful) Symfony bundles
  [#5095] Fixing a typo and updating to a more realistic example
  [#4228] Move synthetic services to its own recipe
  clarify bundle installation instructions
  Implemented the suggestions made by Christian and Wouter
  Replace phpDocumentor by the standard PHPDoc
  Implemented the changes suggested by reviewers
  Fixed an internal link reference
  Reviewed the Bundles cookbook articles
  Constraints - empty strings and null values
  Add a caution to the getUploadRootDir - correction
  Adding a caution to the getUploadRootDir() method
  [#4228] Moved requiring files to definitions
weaverryan added a commit that referenced this pull request Jun 19, 2015
* 2.6:
  [#5373] Small tweak per Stof's comment
  Fixed a minor grammar issue
  Fixed typos
  Link to the official repository of the bundle.
  Added mentions to some popular (and useful) Symfony bundles
  [#5095] Fixing a typo and updating to a more realistic example
  [Components][ClassLoader] remove DebugClassLoader
  [#4228] Move synthetic services to its own recipe
  clarify bundle installation instructions
  Implemented the suggestions made by Christian and Wouter
  Replace phpDocumentor by the standard PHPDoc
  Implemented the changes suggested by reviewers
  Fixed an internal link reference
  Reviewed the Bundles cookbook articles
  Constraints - empty strings and null values
  Add a caution to the getUploadRootDir - correction
  Adding a caution to the getUploadRootDir() method
  [#4228] Moved requiring files to definitions
weaverryan added a commit that referenced this pull request Jun 19, 2015
* 2.7: (23 commits)
  [#5331] Tiny typo
  [#5373] Small tweak per Stof's comment
  [PSR-7] Bridge documentation
  Fix after install URL and new photo since AcmeDemoBundle is not part of 2.7
  Fixed a minor grammar issue
  Fixed typos
  Link to the official repository of the bundle.
  Added mentions to some popular (and useful) Symfony bundles
  [#5095] Fixing a typo and updating to a more realistic example
  [Components][ClassLoader] remove DebugClassLoader
  [#4228] Move synthetic services to its own recipe
  clarify bundle installation instructions
  Implemented the suggestions made by Christian and Wouter
  Replace phpDocumentor by the standard PHPDoc
  Implemented the changes suggested by reviewers
  Fixed an internal link reference
  Reviewed the Bundles cookbook articles
  Updated the list of reserved domains and the URL reference
  Use the reserved domains example.com and example.org
  Constraints - empty strings and null values
  ...
weaverryan added a commit that referenced this pull request Jun 19, 2015
* 2.8: (24 commits)
  [#5331] Tiny typo
  [#5373] Small tweak per Stof's comment
  Added depreciation note for the cascade_validation constraint and updated position of depreciation notes
  [PSR-7] Bridge documentation
  Fix after install URL and new photo since AcmeDemoBundle is not part of 2.7
  Fixed a minor grammar issue
  Fixed typos
  Link to the official repository of the bundle.
  Added mentions to some popular (and useful) Symfony bundles
  [#5095] Fixing a typo and updating to a more realistic example
  [Components][ClassLoader] remove DebugClassLoader
  [#4228] Move synthetic services to its own recipe
  clarify bundle installation instructions
  Implemented the suggestions made by Christian and Wouter
  Replace phpDocumentor by the standard PHPDoc
  Implemented the changes suggested by reviewers
  Fixed an internal link reference
  Reviewed the Bundles cookbook articles
  Updated the list of reserved domains and the URL reference
  Use the reserved domains example.com and example.org
  ...
javiereguiluz pushed a commit to javiereguiluz/symfony-docs that referenced this pull request Sep 2, 2015
@javiereguiluz javiereguiluz deleted the update_bundles_cookbook branch May 24, 2018 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants