cellar get / get-external return signatures and members but no documentation, so you learn a symbol's shape but not its intent.
Example: cats.Monad via get-external org.typelevel:cats-core_3:2.13.0 cats.Monad:
The output shows the signature and every member, but nothing conveys what Monad is for. Its Scaladoc reads:
Monad. Allows composition of dependent effectful functions. Must obey the laws defined in cats.laws.MonadLaws.
Proposal: add an optional --docs flag to the symbol commands (get, get-external) that attaches type-level and per-member doc comments - extracted from the sources jar / TASTy - alongside the existing signatures. Default output stays unchanged.
Workaround: use a different tool for documentation, such as javadocs
cellar get/get-externalreturn signatures and members but no documentation, so you learn a symbol's shape but not its intent.Example:
cats.Monadviaget-external org.typelevel:cats-core_3:2.13.0 cats.Monad:The output shows the signature and every member, but nothing conveys what
Monadis for. Its Scaladoc reads:Proposal: add an optional
--docsflag to the symbol commands (get,get-external) that attaches type-level and per-member doc comments - extracted from the sources jar / TASTy - alongside the existing signatures. Default output stays unchanged.Workaround: use a different tool for documentation, such as javadocs