You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is just a suggestion. I know I will be able to overload specific partial template layouts myself to handle this for the documentation I'm working on, but I figured I'd open an issue to discuss this, just in case other people may think this could be a good idea as well.
Ok, so, currently the method docblock is ordered like this:
Summary
Signature
Description
Parameters
Tags
Return values
Now, in case there are several arbitrary tags, this moves the "Return" section quite far down from the parameters and the function signature, making these feel disconnected.
Aside from that, while not strictly a return value, the exceptions thrown are shown under "Tags", while to me it would make more sense to show them either in a separate block section or in a sub-section of the "Return" section.
So, I was wondering how people would feel about a re-ordering like this:
Opinions ?
The text was updated successfully, but these errors were encountered:
Template issue/request
This is just a suggestion. I know I will be able to overload specific partial template layouts myself to handle this for the documentation I'm working on, but I figured I'd open an issue to discuss this, just in case other people may think this could be a good idea as well.
Ok, so, currently the method docblock is ordered like this:
Now, in case there are several arbitrary tags, this moves the "Return" section quite far down from the parameters and the function signature, making these feel disconnected.
Aside from that, while not strictly a return value, the exceptions thrown are shown under "Tags", while to me it would make more sense to show them either in a separate block section or in a sub-section of the "Return" section.
So, I was wondering how people would feel about a re-ordering like this:
Opinions ?
The text was updated successfully, but these errors were encountered: