[PSR-19] Working Group Plan

61 views
Skip to first unread message

Chuck Burgess

unread,
Oct 31, 2018, 1:57:10 PM10/31/18
to php...@googlegroups.com
Ok, Working Group, let's start small...

I've gone through the tag catalog (phpdoc-tags.md), and made notes on each tag as it is *currently* shown in the catalog.

I see these tags as being perfectly fine, needing no changes: api [1], author [2], copyright [3], todo [4].

I'd like the group to look specifically at those sections only, and decide:
- does anything need to be removed
- is any wording unclear
- does it *not* fit with *your* implementation

As we reach consensus on each section, I'll do a PR to mark the section as "approved by WG"... these markers will be removed before the acceptance vote.

Once we're past this step, I'll bring up specific things on another tag section or two. This way, we keep the amount of open topics from getting unwieldy.

Granted, the amount of ML threads is beyond such control, so join those discussions as you are able.

Does this approach sound ok to the WG?


Chuck Burgess

unread,
Nov 8, 2018, 3:21:13 PM11/8/18
to php...@googlegroups.com
Working Group,

Given one approval on the first four tags (api, author, copyright, todo), the PR to mark them approved is ready for your review [1].  Also, the last "cleanup / from-old-fork" PR [2] still needs an approval so that I can pull in that last batch of changes.

In looking over my initial notes on all the remaining tags, I'm thinking these four will be the easiest to discuss next:
* category [3]
  - Rather than list it as deprecated, should be just leave it out altogether?
* deprecated [4]
  - The syntax already contains the Ending Version... should we take that out?  I don't know that the merits of including it was ever justified.
* global [5]
  - I definitely think we should leave this out... let @uses do its job.
* license [6]
  - If we decide to drop file-level docblocks altogether, should the license tag even continue to exist?  Do we really want to license elements individually?

Please consider my questions and reply.  For any of these tags that you do feel should remain in the catalog, please look specifically at those sections and decide:
- does anything need to be removed
- is any wording unclear
- does it *not* fit with *your* implementation

Reply all
Reply to author
Forward
0 new messages