Minor update to the Error Handling docs #181
Conversation
This change completes some of the PHP code examples, so that it's clear that the example refers to an entire file, as well as provides an example for enabling the example LoggingErrorListenerDelegatorFactory used in the docs, for those unfamiliar with delegator factories (and those who are a little rusty with them). Signed-off-by: Matthew Setter <matthew@matthewsetter.com>
settermjd
force-pushed
the
update-error-handling-docs
branch
from
31d77da
to
66b096e
Compare
| @@ -195,6 +200,9 @@ You could then use a [delegator factory](container/delegator-factories.md) to | |||
| create your logger listener and attach it to your error handler: | |||
|
|
|||
| ```php | |||
| <?php | |||
There was a problem hiding this comment.
IMO just noise, but I don't know our convention here
There was a problem hiding this comment.
It could well be and I appreciate what you're saying. However, it's a convention that I've seen in most other online documentation and examples wrt PHP for some time now.
There was a problem hiding this comment.
@settermjd
The problem here is that we don't have a definition to mark parts of code from files.
See in the documentation of Doctrine ORM:
This example is logical:
<?php // src/Bug.php class Bug { public function close() { $this->status = "CLOSE"; } }
But this one is not:
<?php $product = $entityManager->getRepository('Product') ->findOneBy(array('name' => $productName));
Therefore, any suggestion is welcome. Please add it to the documentation repository.
Thanks in advance! 馃憤馃徎
| @@ -154,6 +156,9 @@ allowing the listener the ability to introspect the generated response as well. | |||
| As an example, you could create a logging listener as follows: | |||
|
|
|||
| ```php | |||
| <?php | |||
There was a problem hiding this comment.
IMO just noise, but I don't know our convention here
| <?php | ||
| declare(strict_types=1); | ||
|
|
There was a problem hiding this comment.
Excerpt from the Writers Guide:
To standardize the examples and reduce unnecessary repetition, the following rules must be observed:
- PHP's open and close tags are only allowed in code examples for view scripts
- the declare construct must be omitted
There was a problem hiding this comment.
Might it be worth adding a documented exception in this case? As always, I'm happy to go with the group consensus.
| <?php | ||
| declare(strict_types=1); | ||
|
|
There was a problem hiding this comment.
Excerpt from the Writers Guide:
To standardize the examples and reduce unnecessary repetition, the following rules must be observed:
- PHP's open and close tags are only allowed in code examples for view scripts
- the declare construct must be omitted
Co-authored-by: Frank Br眉ckner <info@froschdesignstudio.de> Signed-off-by: Matthew Setter <matthew@matthewsetter.com>
Co-authored-by: Frank Br眉ckner <info@froschdesignstudio.de> Signed-off-by: Matthew Setter <matthew@matthewsetter.com>
Co-authored-by: Frank Br眉ckner <info@froschdesignstudio.de> Signed-off-by: Matthew Setter <matthew@matthewsetter.com>
Description
This change:
LoggingErrorListenerDelegatorFactoryused in the docs, for those unfamiliar with delegator factories (and those who are a little rusty with them 馃槃).