com-lihaoyi / mill

Mill is a fast JVM build tool that supports Java and Scala. 2-4x faster than Gradle and 4-10x faster than Maven for common workflows, Mill aims to make your project’s build process performant, maintainable, and flexible
https://mill-build.org/
MIT License
2.19k stars 347 forks source link

`inspect` should render a parameter usage help for commands #2198

Closed lefou closed 1 year ago

lefou commented 1 year ago

The inspect command already prints the scaladoc. Whan commands have parameters documented with @param, we already see them too, but often parameters are not documented. Also, if we use dedicated classes that used the delegation support on mainargs, we don't see the documentation.

As Mill is automatically supporting parameters with mainargs and mainargs can render nice usage displays, we should include such usage output to the output of inspect.

lefou commented 1 year ago