click icon indicating copy to clipboard operation
click copied to clipboard

Meta Issue for Project Opinions

Open Rowlando13 opened this issue 1 year ago • 2 comments

In rewriting the documentation, I have seen a number of opinions that shaped the project. The opinions don't have to do with arbitrary nesting of command, automatic help page generation, or lazy loading of sub commands, and so are really up for discussion. I will try to give reasoning for why that opinion appears to be held. I will also try to give a feature which might be unlocked if we don't hold it. Opinions about parsing behavior will not be discussed because they will be discussed separately at some point in the future.

What I assume to be the POSIX Standards for Utilities that are mentioned in the docs. From a brief look, these are the aimed for standards with backward compatibility taking precedence.

Issues are mostly locked until I get a few more up to give people more concrete examples to look at.

TBD

  • [x] #2822
  • [ ] #2824

Decided

Rowlando13 avatar Dec 15 '24 06:12 Rowlando13

https://github.com/pallets/click/issues/2822

  • I get trying to be posix compliant, but shouldn't that be a choice for the user of the library and not the library? If I want to add help text to an argument with an OPTIONAL parameter, shouldn't that be available? If this opinion impacted some fundamental design decisions, then I would understand more why this debate is worth having, but it seems that the opinion is literally just not to include an optional "help" parameter in arguments.
  • Also separately, I see no reason why any NEW cli tools need to be "backwards compatible"

maxschommer avatar Jun 19 '25 19:06 maxschommer

@maxschommer I unlocked the issue, please post on the specific issue rather than on this meta issue.

davidism avatar Jun 19 '25 22:06 davidism