[PSR-5][PSR-19] Weekly Update 2018-11-08

[Chuck Burgess]

Hello everyone,

Over the past week, I've received some Working Group [1] agreement on the acceptance of the first four Tags to review.  I have issued a PR [2] to mark those tags as such, and will next look for another one to four tags to review next.  Again, the rationale is that by working just a few tags at a time, we hope to bring the drafts up to a "minimum baseline" of acceptance before diving heavily into more expansive topics of discussion.

ML Activity

We have several open threads of discussion, including a new thread on the Description piece of the @var Tag [3].  Everyone interested in contributing to discussions should get involved on these threads.

Discussion on an Intersection operator [4] for Types remains centered on how to deal with a Tag's Type section that needs both "|" Union and "&" Intersection operators to be used together.

Discussion on the Nullable Types [5] might be close to resolution, if there's no opposition to just using a single "?" for the entire Type string as a means to mark it all Nullable.

Discussion on the Variadics [6] might also be close to resolution, if there are no further use cases to consider with regard to "[]" usage.

The ML discussion of the "full stop" on the DocBlock Summary [7] seems to have wrapped up, so I've merged its accompanying PR accordingly and will consider the thread closed.

PR Activity

Given WG approvals on the PR and no negative feedback on the ML thread, I have merged the deprecation of the double }} closing braces for the inline @internal Tag [8].

Another merged PR from the WG expands the old Exception language for the @throws Tag to recognize that Throwable is now the top level element of that hierarchy. [9]

The last remaining cleanup Pull Request [10] continues to await WG approvals.

Going Forward

I'll next be looking for one to four tags for the WG to look it to see if the Tag Catalog verbiage needs modifications... these will be identified on a new Working Group Plan thread on the ML.

As before, I hope to keep any given week's level of WG work limited to just a few minutes of click-it & look-at-it & ( ok-it | slack-about-it ).  Again, this is strictly to get the drafts up to a minimum baseline of content and consensus.

Aside from contributing, if you have feedback on the structure or content of this update email, please let me know.

Chuck Burgess, Editor
about.me/ashnazg

[1] -- https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-meta.md#5-people

[2] -- https://github.com/php-fig/fig-standards/pull/1113 -- "[PSR-19] mark four tags as approved by WG"

[3] -- https://groups.google.com/forum/#!topic/php-fig/vwerL4lJpAs -- "[PSR-19] Standard for describing properties with the @var tag"

[4] -- https://groups.google.com/forum/#!topic/php-fig/W1VyAtoqGQ8 -- "[PSR-5] Intersection Types"

[5] -- https://groups.google.com/forum/#!topic/php-fig/5A5ytQyV6Oo -- "[PSR-5] Nullable type shorthand in PHPDoc (e.g. `@return ?string`)"

[6] - https://groups.google.com/forum/#!topic/php-fig/zFMcfjYAS7M -- "PSR-5] Variadic Parameters"

[7] -- https://groups.google.com/forum/#!topic/php-fig/59qEeX-VkZU -- "[PSR-5] Summary"

[8] -- https://groups.google.com/forum/#!topic/php-fig/KckIDHss-QI -- "[PSR-19] deprecate double closing brace on inline internal tag"

[9] -- https://github.com/php-fig/fig-standards/pull/1081 -- "[PSR-19] @throws - also include subtypes of Throwable"

[10] -- https://github.com/php-fig/fig-standards/pull/1097 -- "Downstream changes from phpDocumentor/fig-standards fork"