I've made the PR: https://github.com/php-fig/fig-standards/pull/1106
Thanks! -- Woody Gilk https://shadowhand.me On Fri, Oct 26, 2018 at 8:19 AM Chuck Burgess <demon.g...@gmail.com> wrote: > Yes, I agree. I believe this requirement in the original draft was in > line with phpDocumentor's requirement that a Summary *and* Description > should *both* be present in DocBlocks. In that context, the requirement > makes sense. > > Since the spec is only delineating how the pieces in a DocBlock should be > shaped, then your suggestion reads well. I'll issue a PR on it, unless you > want to, Woody. > CRB > > On Thursday, October 25, 2018 at 1:54:51 PM UTC-5, Woody Gilk wrote: >> >> The PSR-5 recommendation for a summary doesn't make sense: >> >> A Summary MUST end with either >> >> >> - a full stop (.) followed by a line break >> - or two sequential line breaks. >> >> The following would be considered an invalid docblock under PSR-5... >> >> /** >> * Opens a file if it is readable >> */ >> public function openReadable(string $file): File; >> >> I think that the summary section should be modified to: >> >> A Summary MUST end with two sequential line breaks, if the block contains >> any content other than the summary. >> >> >> That seems most congruent with how people are using phpdoc, across all of >> the projects that I contribute to. Anyone else have thoughts on this? >> -- >> Woody Gilk >> https://shadowhand.me >> > -- > You received this message because you are subscribed to the Google Groups > "PHP Framework Interoperability Group" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to php-fig+unsubscr...@googlegroups.com. > To post to this group, send email to php-fig@googlegroups.com. > To view this discussion on the web visit > https://groups.google.com/d/msgid/php-fig/f60e8d3a-7385-4a5c-a9b2-6c1d5da6c732%40googlegroups.com > <https://groups.google.com/d/msgid/php-fig/f60e8d3a-7385-4a5c-a9b2-6c1d5da6c732%40googlegroups.com?utm_medium=email&utm_source=footer> > . > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group. To unsubscribe from this group and stop receiving emails from it, send an email to php-fig+unsubscr...@googlegroups.com. To post to this group, send email to php-fig@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/CAGOJM6%2BQNpNzDKHKE0o-Uy20Jzpvrr4jyttBE_G1hL4N_Yk6gQ%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
