Please check if the PR fulfills these requirements
[x] The commit message follows our guidelines
[ ] Tests for the changes have been added (for bug fixes/features)
[ ] Docs have been added/updated (for bug fixes/features)
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Bug fix (doc bloc)
What is the current behavior? (You can also link to an open issue here)
ReadOnlyContainer::get() return type is documented as object, but not it can return anything
There are a few @psalm-suppress doc bloc that does nothing, I found them via --find-unused-psalm-suppress
BaseProperties make use of {@inheritDoc}. Besides of the fact that is not a standard doc bloc tag, but an inline tag that makes sense when used in beween other doc bloc, BaseProperties is the only class making use of it, so I think it makes sense to remove it for consistence with the rest of the codebase
What is the new behavior (if this is a feature change)?
ReadOnlyContainer::get() documented as mixed return type
Removed unused @psalm-suppress
Removed {@inheritDoc} from BaseProperties, replacing with standard docBloc
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Please check if the PR fulfills these requirements
[x] The commit message follows our guidelines
[ ] Tests for the changes have been added (for bug fixes/features)
[ ] Docs have been added/updated (for bug fixes/features)
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Bug fix (doc bloc)
What is the current behavior? (You can also link to an open issue here)
ReadOnlyContainer::get()
return type is documented asobject
, but not it can return anythingThere are a few
@psalm-suppress
doc bloc that does nothing, I found them via--find-unused-psalm-suppress
BaseProperties
make use of{@inheritDoc}
. Besides of the fact that is not a standard doc bloc tag, but an inline tag that makes sense when used in beween other doc bloc,BaseProperties
is the only class making use of it, so I think it makes sense to remove it for consistence with the rest of the codebaseWhat is the new behavior (if this is a feature change)?
ReadOnlyContainer::get()
documented asmixed
return typeRemoved unused
@psalm-suppress
Removed
{@inheritDoc}
fromBaseProperties
, replacing with standard docBlocDoes this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No.
--