On Friday, October 26, 2018 10:29:15 AM CDT Woody Gilk wrote: > > if the summary is rather big and contains commas or even full stops > > inside > > That violates the purpose of the summary. The summary is meant to be the > > "title" of a block, as per description: > > A Summary MUST contain an abstract of the "Structural Element" defining > > the purpose. It is RECOMMENDED for Summaries to span a single line or at > most two, but not more than that. > > It wouldn't make sense to write the chapter of a book as "The Boy Who > Lived." instead of "The Boy Who Lived", right? > -- > Woody Gilk > https://shadowhand.me
I am also in the always-period camp. Every docblock I've ever written has a period on the summary, because that's how you end sentences. I would also say they should be capped at one line, not just recommended to be under 2 lines. If you need more than that, that's what the description is for. --Larry Garfield -- 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 [email protected]. To post to this group, send email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/11771111.PGZR9nQHo3%40vulcan. For more options, visit https://groups.google.com/d/optout.
signature.asc
Description: This is a digitally signed message part.
