Support for array shape descriptions - Copy changes from jdpedrie/Sami ?

[williamdes]

Hi @jdpedrie
You made changes on https://github.com/jdpedrie/Sami and implemented them for https://github.com/googleapis/google-api-php-client

You you mind implementing them here ?

[jdpedrie]

Hi @williamdes,

Here is the comparison of changes I made. I'd love to help get it added here, but my free time is limited at the moment. I may be able to work on it in the near future, but not right now. Additionally, I doubt my changes would meet the acceptable standards for the library! It is sort of a hack that I made without deep knowledge of Sami.

For anyone curious, here is an example of what my change handles, and here is the output.

[williamdes]

Hi @jdpedrie
I assigned this to 5.2, nothing sure but I could try to get the changes incorporated and make this non PHP standard support optional.
What do you think about that idea ?

[jdpedrie]

That would be great! Please let me know if I can help with review or testing, and again if I find some time I'll let you know and try to jump back in with more concrete assistance.

[williamdes]

Psalm also has a custom format, this should be implemented too I think

[williamdes]

phpstan/phpstan#2173

[jdpedrie]

I'm agnostic as to the format supported, except unless I've missed something, these formats don't appear to support array member descriptions, which is a requirement for us. I'd love to provide documentation in a format recognized by static analyzers, so long as we can also provide the descriptions.

[williamdes]

I'm agnostic as to the format supported, except unless I've missed something, these formats don't appear to support array member descriptions, which is a requirement for us. I'd love to provide documentation in a format recognized by static analyzers, so long as we can also provide the descriptions.

@muglug @ondrejmirtes do you have some suggestions on this idea ?
I am asking because you "created" the array shape formats :)