Repository navigation
The install says which plugin, and what happens without it - #39
Merged
Merged
Conversation
The README's requirement said "a plugin" and named it two sentences later, so a consumer who stopped at the requirement did not know what to allow, and "the library refuses to work" said nothing about what they would meet. The requirement names cweagans/composer-patches where it is stated, and the page says what follows: the install stops with Composer's own message, and a conversion against an unpatched PHPPresentation raises MarkdownPresentation\Exception\UnpatchedDependency, whose message names the plugin as well. The page also names the five methods the patch adds and which direction needs each, because the check asks for all five in either direction and refuses a package that carries only some: what is missing fails somewhere else, naming a method rather than the reason, or is quietly left out of the deck that comes back. The guard reads the required methods out of Fixes::REQUIRED by reflection, so a patch that grows a method makes the page a list of the methods there are.
|
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
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.



The install says which plugin, and what happens without it.
What was wrong
The README said a consumer "has to allow a plugin" and named
cweagans/composer-patchestwo sentences later. It said the library "refuses to work", which is not something a consumer can act on. And it listed three of the five fixes the patch adds, without saying what the other two are for, or why the check asks for all five in both directions.What the README says now
cweagans/composer-patches.MarkdownPresentation\Exception\UnpatchedDependency, whose message names the plugin as well.Table::setFirstRowAutoShape::setRoundRectCornerRichText::setDescriptionPowerPoint2007::zipPathGd::setContentsand why the check asks for all five in either direction: a package that carries only some is refused rather than half-worked. What is missing either fails somewhere else — naming a method rather than the reason — or is quietly left out of the deck that comes back.
Nothing promises the patch goes away.
The claims
tests/Readme/installation.phpalready read the README and the manifest, so that what is asked of a consumer follows the library rather than the other way round. Three claims are added:src/Fixes.phpby reflection, so the list follows the code and cannot rot when the patch changes.Each was shown red by editing the README (and, for the third,
src/Fixes.php) and reverting: the old README fails the first claim too.Before v0.3.0
This has to land before the tag, so it ships in the release.