🐛 Ensure that options_metavar is passed through correctly

[gar1t]

Typer was ignoring this setting when provided to commands. Refer to added test for details.

[svlandeg]

Thanks!

I have yet to check the test case, but a few quick first comments:

[svlandeg]

I double checked the unit test and found that the second option (c2) is already working correctly on master, while the first one (c1) fails. Nevertheless, it's good to have both options checked here.

One thing I wonder about though. If you change "OPTIONS" to "OPTS" or something different entirely like "STUFF", the box with options in the help menu would still be named "Options".

$ python script.py --help

 Usage: script.py [STUFF]

┌─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ --install-completion          Install completion for the current shell.                                                                                                                                                                                                                         │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                                                                                                                                                                  │
│ --help                        Show this message and exit.                                                                                                                                                                                                                                       │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Is this something that should be addressed as well?

[gar1t]

One thing I wonder about though. If you change "OPTIONS" to "OPTS" or something different entirely like "STUFF", the box with options in the help menu would still be named "Options".

$ python script.py --help

 Usage: script.py [STUFF]

┌─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ --install-completion          Install completion for the current shell.                                                                                                                                                                                                                         │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                                                                                                                                                                  │
│ --help                        Show this message and exit.                                                                                                                                                                                                                                       │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Is this something that should be addressed as well?

I think that's a good idea!

But the goal of this PR is to fix a bug that currently prevents options_metavar from propagating to sub-commands. I believe the current PR accomplishes that and should be merged and closed.

I would classify your point here as an enhancement to the API to support configuration of the panel label/title. This could be captured as a new feature request, while merging this PR.

[svlandeg]

But the goal of this PR is to fix a bug that currently prevents options_metavar from propagating to sub-commands. I believe the current PR accomplishes that and should be merged and closed.

I would classify your point here as an enhancement to the API to support configuration of the panel label/title. This could be captured as a new feature request, while merging this PR.

Agreed that we can address this as future work!