Skip to content

Conversation

@jkburges
Copy link

Copy link

@modsaid modsaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense...

suggestion: do we need to clarify where that the default can change in the config files as well?

@jkburges
Copy link
Author

suggestion: do we need to clarify where that the default can change in the config files as well?

I don't understand what you mean here, sorry.

@modsaid
Copy link

modsaid commented May 11, 2020

@jkburges sorry about that, let me elaborate..

The current default is 25 (in the configuration file).. the help message indicates default of 10 which is incorrect.
Changing to 25 should be correct as a default.

However, if the help message changed to 25, and the the config file was changed (by the user after installation or by any other user with access to the system, to 20 for example)... the cli usage would still indicate 25 which is now incorrect

One suggestion can be looking up the value in the config file and populate it as the default in the help message... but that's a bit of an overkill

Another suggestion, which i meant above, is: Perhaps in the help message itself, we can state that the default might be overwritten in the help file.

The whole point is not deceiving the end user by giving incorrect info

@jkburges jkburges force-pushed the fix-concurrent-doc branch from 73ffee7 to 5b1988b Compare May 11, 2020 23:30
@jkburges
Copy link
Author

@modsaid I understand, thanks.

Have added a note about that - and I had a conflict and a bunch of unintentional whitespace changes, so I've force pushed a new commit.

@modsaid
Copy link

modsaid commented May 11, 2020

Thanks, I guess it is up to @JoeDog now..

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

Successfully merging this pull request may close these issues.

2 participants