Update toHtml method return type and docblock#14
Merged
oladoyinbov merged 1 commit intofastvolt:v0.2.4from Oct 15, 2025
Merged
Conversation
Refactor toHtml method to return nullable string and add exception documentation.
oladoyinbov
approved these changes
Oct 15, 2025
Contributor
Author
|
@oladoyinbov It would be great if you could release a new minor version which includes this change. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes
toHtml's docblock of the return types.Method
toHtmlhad@return string|null|\LogicExceptionin the PHPDoc, but an instance ofLogicExceptionis never returned, only thrown when a certain situation occurs. Also duplicating return values in PHPDoc as well as in the code might lead to outdated code.The current situation confuses PHPStan and one must add custom PHPDoc to "force" a certain behavior.