diff options
| author | C. Scott Ananian <cscott@cscott.net> | 2022-02-07 12:16:23 -0500 |
|---|---|---|
| committer | C. Scott Ananian <cscott@cscott.net> | 2022-02-07 12:16:23 -0500 |
| commit | 1a34a2d7615e320ad5ee6a3db12c92f73bd26b4c (patch) | |
| tree | 686f2169396b46fc893c615ba42703203f8cbc76 | |
| parent | 1161d3cb9c66941ad62ff97970f84a6c1eb713c0 (diff) | |
| download | mediawikicore-1a34a2d7615e320ad5ee6a3db12c92f73bd26b4c.tar.gz mediawikicore-1a34a2d7615e320ad5ee6a3db12c92f73bd26b4c.zip | |
Update document comment for new ::appendExtensionData() method
As the @note says, only types which can be array keys are currently supported
as values. Fix the phan @param to match.
(In the future we might use a different data representation which would
allow richer types, but we're starting simple.)
Change-Id: I141dc5381a8b260a3a99553b7855a1fd01b0170f
| -rw-r--r-- | includes/parser/ParserOutput.php | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index d591c28f2f64..569d0dfc22f9 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -1607,12 +1607,13 @@ class ParserOutput extends CacheTime { * parsing, this method appends values to a set. See * ::setExtensionData() for the flag-like version of this method. * - * @note Only values which can be array keys are supported as a value. + * @note Only values which can be array keys are currently supported + * as values. * * @param string $key The key for accessing the data. Extensions should take care to avoid * conflicts in naming keys. It is suggested to use the extension's name as a prefix. * - * @param mixed|JsonUnserializable $value The value to append to the list. + * @param int|string $value The value to append to the list. * @since 1.38 */ public function appendExtensionData( string $key, $value ): void { |