Mistake in the composer command in the documentation - Githubissues

zendframework / zend-di

Di component from Zend Framework

BSD 3-Clause "New" or "Revised" License

46 stars 29 forks source link

Mistake in the composer command in the documentation #43

Closed webroru closed 5 years ago

webroru commented 5 years ago

In the documentation for the zend-di section of the Quick Start, item 1 Installation (https://docs.zendframework.com/zend-di/quick-start/#1-installation), an mistake was made in the example commands for installing the module.

Provide a narrative description of what you are trying to accomplish:

[ ] Are you fixing a bug?
- [ ] Detail how the bug is invoked currently.
- [ ] Detail the original, incorrect behavior.
- [ ] Detail the new, expected behavior.
- [ ] Base your feature on the master branch, and submit against that branch.
- [ ] Add a regression test that demonstrates the bug, and proves the fix.
- [ ] Add a CHANGELOG.md entry for the fix.
[ ] Are you creating a new feature?
- [ ] Why is the new feature needed? What purpose does it serve?
- [ ] How will users use the new feature?
- [ ] Base your feature on the develop branch, and submit against that branch.
- [ ] Add only one feature per pull request; split multiple features over multiple pull requests
- [ ] Add tests for the new feature.
- [ ] Add documentation for the new feature.
- [ ] Add a CHANGELOG.md entry for the new feature.
[ ] Is this related to quality assurance?
[X] Is this related to documentation?

tux-rampage commented 5 years ago

Thanks a lot for pointing this out. @weierophinney will this Auto-Update the documentation when merged or do we need a release?

weierophinney commented 5 years ago

@tux-rampage Documentation is built on each successful build of the master branch, so it only needs to be merged and pushed.