gleam
gleam copied to clipboard
Command to show documentation from CLI
In the style of Go
I might wanna give this a whirl. Some clarification questions:
What should the command be? I think maybe it should be under gleam docs
. Maybe gleam docs show <import-path>
?
What should we be able to show? I think probably anything public that can get a doc-comment right? For a module, we'd maybe want to print 1. The //// module docs, 2. All the contained public items (types, functions) with their docs, 3. A tree view of available submodules to explore?
I don't have any specific ideas. The first step would likely be to come up with some designs for the interface and the output and make some mock-ups. Then we can implement it.
Having said that, I think this is probably one of the lowest value issues in the tracker, it may be a better to work on something that'll have more of an impact of the average Gleam programmer.