Split PSR-5 into two PSR proposals #1038
Conversation
|
Ping Working Group (@michaelcullum @neuro159 @muglug @ondrejmirtes) |
proposed/phpdoc-meta.md
Outdated
| susceptible to becoming out of date. | ||
|
|
||
| PHPDoc as a notation has existed for more than ten years now, is heavily inspired by JavaDoc, and is currently in use by a | ||
| significant percentage of public PHP projects in the field. | ||
| PHPDoc as a notation has existed for more than fifteen years now, is heavily inspired by JavaDoc, |
There was a problem hiding this comment.
Ulf Wendel presented phpdoc and its notation in October 2000. In case you want to be more exact than "more than fifteen years" ;-)
There was a problem hiding this comment.
I was wondering about that... my only mental timeline was knowing roughly when Josh had it and Greg joined in :-D
There was a problem hiding this comment.
relative time information without a clear reference date ages badly - maybe mention a year instead of "x years ago" which will be outdated next year...
There was a problem hiding this comment.
Yep, that's what I'll be doing now that I have the actual landmark.
|
Looks good to me. I think it is good to split this psr in 2. Definition format and tags are different things |
|
Looks good to me |
|
@neuro159 @muglug @ondrejmirtes since we are using PullApprove, you can use GitHub's reviews to signal your 👍 |
proposed/phpdoc-meta.md
Outdated
|
|
||
| ### 3.2 Non-Goals | ||
|
|
||
| * This PSR does not provide a recommendation on how and when to use the concepts described in this document, | ||
| so it is not a coding standard. | ||
| * This PSR does not introduce new concepts that guess at matching best practices or design patterns in the foreseeable |
There was a problem hiding this comment.
I feel this conflicts with Ln 22.
proposed/phpdoc-meta.md
Outdated
| * This PSR does not introduce new concepts that guess at matching best practices or design patterns in the foreseeable | ||
| future. | ||
| * This PSR does not provide a recommendation on how and when to use the concepts described in this document, so it is | ||
| not a coding standard. | ||
| * This PSR facilitates the creation of annotations by allowing the notation needed for Symfony/Doctrine style |
There was a problem hiding this comment.
I'd remove this as a non-goal, but not add it as a goal so we have some intentional ambiguity there honestly.
proposed/phpdoc-tags-meta.md
Outdated
|
|
||
| ## 1. Summary | ||
|
|
||
| The purpose of this PSR is to document (in a catalog style) the de facto list of Tags historically in use |
There was a problem hiding this comment.
Tags shouldn't be capitalised throughout as it's not a proper noun.
|
@neuro159 @ondrejmirtes ? The phpDocumentor team wants to send in some PRs, but this split will need to merge first. |
|
|
|
Ping @michaelcullum @Jean85 ... is this ok to merge now? |
|
Where is the working group currently discussing and working on things? I was heavily involved in PSR-5 previously and have some important things I'd like to point out. |
|
@mindplay-dk please reach out to @ashnazg to get involved. If needed, involve me too. |
|
@Jean85 I've sent him an e-mail, thanks :-) |
No description provided.