Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] custom map: Keep descriptions of builtin arguments #1103

Open
zstadler opened this issue Nov 15, 2024 · 0 comments
Open

[FEATURE] custom map: Keep descriptions of builtin arguments #1103

zstadler opened this issue Nov 15, 2024 · 0 comments

Comments

@zstadler
Copy link
Contributor

Is your feature request related to a problem? Please describe.
When the value of a builtin argument is set by a custom map YAML file, the description is not shown in the log.

For example, when using the original value and description of tmpdir, the log file says:

0:00:00 DEB - argument: tmpdir=data/tmp (temp directory)

When changing the value of tmpdir,

args:
  tmpdir: "/tmp"

the log file says:

0:00:00 DEB - argument: tmpdir=/tmp (no description provided)

It is also possible to set any description for the built argument. For example,

args:
  tmpdir: 
    description: Toronto Motorsports Park direction
    default: "/tmp"

will produce this log line:

0:00:00 DEB - argument: tmpdir=/tmp (Toronto Motorsports Park direction)

Describe the solution you'd like
I'd like the description of builtin arguments to be kept regardless of existence or non-existence of a description: key in their override in the custom map YAML.

In both examples above, I would expect the log file to say:

0:00:00 DEB - argument: tmpdir=/tmp (temp directory)
@zstadler zstadler changed the title [FEATURE] custom map: Keep descxription of builtin args [FEATURE] custom map: Keep descriptions of builtin arguments Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant