added docs to Versions::VERSION #81
Merged
Conversation
This file contains 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
the constant is public for technical reasons, therefore should be documented as `@internal`. Added a hint for the public api to use
|
lead by my IDEs autocomplete feature I accidentally read from this public array, instead of using the proper API. this mistake on my end resulted in PackageVersions not using the proper Fallback for the |
Ocramius
requested changes
Mar 25, 2019
| @@ -48,6 +48,12 @@ final class Installer implements PluginInterface, EventSubscriberInterface | |||
| %s | |||
| { | |||
| public const ROOT_PACKAGE_NAME = '%s'; | |||
| /** | |||
| * Array of all available composer packages. | |||
There was a problem hiding this comment.
Can you also add the type of this array? It is array<string, string>
|
should I adjust test expectations or is this something you can do easily? |
|
Yeah, test expectations also need adjusting |
Ocramius
approved these changes
Mar 25, 2019
|
Thanks @staabm! |
Majkl578
reviewed
Mar 26, 2019
| * Array of all available composer packages. | ||
| * Dont read this array from your calling code, but use the \PackageVersions\Versions::getVersion() method instead. | ||
| * | ||
| * @var array<string, string> |
There was a problem hiding this comment.
@var is invalid for constants.
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 constant is public for technical reasons, therefore should be documented as
@internal.Added a hint for the public api to use