Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak comment in DecimalValue::newFromArray #125

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Tweak comment in DecimalValue::newFromArray #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44119cc
Tweak comment in DecimalValue::newFromArray
JeroenDeDauw Jan 4, 2019
c8d628c
Update DecimalValue.php
JeroenDeDauw Jan 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions src/DataValues/DecimalValue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,19 +359,14 @@ public function getArrayValue() {
}

/**
* Constructs a new instance from the provided data. Required for @see DataValueDeserializer.
* This is expected to round-trip with @see getArrayValue.
* Constructs a new instance from the provided data. Round-trips with @see getArrayValue.
*
* @deprecated since 0.8.3. Static DataValue::newFromArray constructors like this are
* underspecified (not in the DataValue interface), and misleadingly named (should be named
* newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.
* @deprecated since 0.8.3. Use the constructor instead, or in case of polymorphic calls,
* use @see DataValueDeserializer.
*
* @param mixed $data Warning! Even if this is expected to be a value as returned by
JeroenDeDauw marked this conversation as resolved.
Show resolved Hide resolved
* @see getArrayValue, callers of this specific newFromArray implementation can not guarantee
* this. This is not guaranteed to be a string!
* param mixed $data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing @

*
* @throws InvalidArgumentException if $data is not in the expected format. Subclasses of
* InvalidArgumentException are expected and properly handled by @see DataValueDeserializer.
* @throws InvalidArgumentException
* @return self
*/
public static function newFromArray( $data ) {
Expand Down