Revise help text for pool metadata source CLI option #2241
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Noticed while reviewing IntersectMBO/cardano-launcher#90. - Fix variable names to reflect the new option - Add more detail to CLI help text
rvl
added
the
IMPROVEMENT
hasufell
approved these changes
Oct 14, 2020
KtorZ
reviewed
Oct 15, 2020
lib/cli/src/Cardano/CLI.hs
Outdated
| <> "Provide a URL to specify a SMASH metadata proxy server, " | ||
| <> "use \"direct\" to fetch directly from the registered pool URLs," | ||
| <> " or \"none\" to completely disable stake pool metadata. " | ||
| <> "This setting will persist across restarts.") |
There was a problem hiding this comment.
Perhaps: "This setting will persist across restarts AND override any previous setting set via this option or via the API." ?
There was a problem hiding this comment.
I'm starting to think it was a bad idea to keep the cli switch. It's confusing. Now someone might still think it pins the setting or something.
There was a problem hiding this comment.
I think it's fine to have a sticky setting like this. Makes sense to me. Anyway, our users are likely to either configure this by the CLI, or by API, but not both.
Reworded a bit more.
KtorZ
approved these changes
Oct 15, 2020
KtorZ
approved these changes
Oct 16, 2020
|
bors merge |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Number
ADP-482
Overview
Noticed while reviewing IntersectMBO/cardano-launcher#90.