SamuelSchlesinger / commander-cli

A simple library I wrote to allow me to quickly and easily construct command line interfaces.

MIT License

29 stars 2 forks source link

document default values #20

Closed BebeSparkelSparkel closed 3 years ago

BebeSparkelSparkel commented 3 years ago

It would be helpful if the documentation could also show the default value.

BebeSparkelSparkel commented 3 years ago

22 implementation failed

generating the docs from ProgramT fails because the it is possible to create bad docs because different value can create different ProgramT.

BebeSparkelSparkel commented 3 years ago

21 has a good implementation for this

SamuelSchlesinger commented 3 years ago

Yeah, this is a hard problem that I've thought a bit about. It sort of doesn't fit in the design I've chosen. My design gains you some dynamism with the default, but loses documentation. It's not obvious to me which is preferred.

SamuelSchlesinger commented 3 years ago

Looking at #21 now.

BebeSparkelSparkel commented 3 years ago

Why not have both then? Prefer the way that documents the defaults but allow for the dynamic values if the user requires them.

SamuelSchlesinger commented 3 years ago

Yeah, I agree with that tact 👍

BebeSparkelSparkel commented 3 years ago

replaced with #40 and #41. Those still need to allow for dynamic values