Issue Type: Docs: Improvement Created: 2009-07-29T20:14:51.000+0000 Last Updated: 2009-08-21T13:53:49.000+0000 Status: Resolved Fix version(s): - 1.9.2 (25/Aug/09)
Reporter: jw (ronny stalker) Assignee: Matthew Weier O'Phinney (matthew) Tags: - Zend_Application
Related issues: - ZF-7416
This issue was spawned from this forum question: http://nabble.com/confusion-between-resource-plugi…
The Problem By reading the ZF Docs for Zend_Controller and Zend_View, the reader is habituated into a more pedantic mode of thought. That is, we learn that the terms to describe objects are very specific.
Under section "4.3.2. Resource Plugins" It says: "Resources need only implement Zend_Application_Resource_Resource, or, more simply still, extend Zend_Application_Resource_ResourceAbstract. "
Under section "4.4. Examples" It says:
Note: * that the words 'Resources' and 'Resource plugins' are used interchangeably to mean the same thing. * there is a typo in the second paragraph: 'Zend_Application_Bootstrap_Resource' should be 'Zend_Application_Resource_Resource' - (issue ticket for typo already is submitted @ ZF-7416 ).
Now imagine a newbie coming to the Zend Framework and reading the documentation on Zend_Application before they read the Zend_Controller (which seems quite likely these days). Instead they will be habituated to read the docs in a less pedantic way.
So, if there is no consistency in the language used to describe a 'resource plugin' or 'resource' within the Zend_Application docs...it will lead to even more confusion when the reader arrives at Zend_Controller and starts learning about 'controllers' and 'controller plugins'.
Just my thoughts.
Posted by jw (ronny stalker) on 2009-07-29T20:23:15.000+0000
Worth being aware of the two issues : * Typo * improvement to docs
to make 'find and replace' go smoothly.
Posted by Matthew Weier O'Phinney (matthew) on 2009-08-21T13:53:49.000+0000
Language updated and made more consistent. Fixes applied to trunk and 1.9 release branch.
Have you found an issue?
See the Overview section for more details.