Fix @throws DocBlock about LogicException #29699
Conversation
This is a follow-up of symfony#28536
|
Well, logic exceptions aren't even supposed to be documented actually. It makes no sense as it represents a broken code path (either a misconfiguration or developer mistake) and should never be caught. |
| /** | ||
| * Create a new Transport Serializer. | ||
| * | ||
| * @return self |
There was a problem hiding this comment.
We tend to avoid adding docs that do not add any additional information (here everything is in the method signature). The same goes for the description above.
|
I agree with @ogizanagi, such exceptions are thrown to provide a meaningful error instead of a fatal one (class not found). Documenting them would not bring any value. 👎 for me |
|
Closing as 2 member of the core voted against this PR. |
|
I understand the point about non documenting LogicException in this case. But the current DocBlock is still wrong (mentions of RuntimeException). Would you accept a PR that remove them? |
|
Yes, removing docblocks is always great! |
This is a follow-up of #28536.
\RuntimeExceptionwere replaced by\LogicExceptionbut the DocBlock documentation wasn't updated accordingly.When working on it, I found some inconsistency: In some component the exception raised is from the SPL (
\LogicException) and in other the exception is from the component itself (when theLogicExceptionexist). What is the policy in this case ?