In practice I don't know how we can not support multi-line tag descriptions. Many parameter descriptions or return descriptions really do need that level of detail, and there's hundreds of thousands of examples of it in the wild. Even many of our own PSRs have multi-line tag descriptions.
It may be hard, but I don't think we can avoid it. We just need to put rules around them that make them both parsable and human-comprehensible. (I know, "just" in that sentence needs really big scare quotes. Simple, but not easy. :-) ) --Larry Garfield On Friday, December 7, 2018 12:39:11 PM CST Jan Tvrdík wrote: > Multiline descriptions for tags are lot more complicated than it may > intuitively seem. Writing a grammar that matches behavior that human > intuitively expects is very tricky. It's not enough to just say, that > multiline descriptions are allowed. For some random examples see > https://github.com/phpstan/phpdoc-parser/issues/6#issuecomment-362243651. > > On Thursday, November 15, 2018 at 3:35:45 PM UTC+1, Marcos Passos wrote: > > Hello folks, > > > > I would like to propose standardizing support to multiline descriptions in > > magic @property and @method annotation. Not allowing it has the impact of > > having long lines with bad readability and no paragraph support. > > > > What is your opinion on that? > > > > - Marcos -- 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/1725610.d5TsaTEq9S%40vulcan. For more options, visit https://groups.google.com/d/optout.
signature.asc
Description: This is a digitally signed message part.
