spring-shell icon indicating copy to clipboard operation
spring-shell copied to clipboard

Add examples section to command documentation

Open FSeidinger opened this issue 7 years ago • 1 comments
trafficstars

For commands it would be helpful, if you can add examples to the command documentation just as some manual pages have it.

I've cloned your project and added an attribute "examples" to the @ShellMethod annotation to achieve this in my private branch. If you want, I can provide a pull request.

Kind regards,

Frank

FSeidinger avatar Jan 12 '18 21:01 FSeidinger

This is something what I've been thinking about lately. With 3.x we should try to make help more customizable with custom sections.

jvalkeal avatar Jul 24 '22 15:07 jvalkeal