fix: filter hard line wrapping from method summaries #19
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.
My company has a policy of hard wrapping lines including doc comments. This leads to broken listing class methods when generating documentation with
phpdoc-md. This PR if accepted filters hard line wraps from method summaries inClean\PhpDocMd\Markdown\ClassInfowhich feels to me as if it is the correct place given existing separation of responsibilities. This change is sufficient for the code bases I work with though I could foresee it being insufficient for others. Included is also a change to the exampleBasicClassshowing the issue is resolved.