Unified text outputs #16559

GChuf commented at 10:45 PM on August 6, 2019: contributor

A few very minor changes to the text outputs. Includes a few dots and spaces changes.

Unified text outputs

A few very minor changes to the text outputs.
Includes a few dots and spaces changes.

00704058a9

fanquake added the label Docs on Aug 6, 2019

in src/bitcoin-cli.cpp:49 in 00704058a9

  43 | @@ -44,14 +44,14 @@ static void SetupCliArgs()
  44 |      const auto regtestBaseParams = CreateBaseChainParams(CBaseChainParams::REGTEST);
  45 |  
  46 |      gArgs.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
  47 | -    gArgs.AddArg("-conf=<file>", strprintf("Specify configuration file. Relative paths will be prefixed by datadir location. (default: %s)", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
  48 | +    gArgs.AddArg("-conf=<file>", strprintf("Specify configuration file. Relative paths will be prefixed by datadir location (default: %s).", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
  49 |      gArgs.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
  50 | -    gArgs.AddArg("-getinfo", "Get general information from the remote server. Note that unlike server-side RPC calls, the results of -getinfo is the result of multiple non-atomic requests. Some entries in the result may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
  51 | +    gArgs.AddArg("-getinfo", "Get general information from the remote server. Note that unlike server-side RPC calls, the result of -getinfo is the result of multiple non-atomic requests. Some entries in the result may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported).", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);

promag commented at 12:17 AM on August 7, 2019:

+0 on result vs results.

GChuf commented at 8:31 AM on August 7, 2019:

It should either be "the result ... is" or "the results ... are".

promag commented at 12:22 AM on August 7, 2019: member

NACK.

FYI the PR implementing #15493 (comment) will update the lines with gArgs.AddArg.

I don't see value in changing the dot position. The same for the new whitespaces.

GChuf commented at 10:27 PM on August 7, 2019: contributor

@promag just to make sure, I have deleted the 2 unnecessary spaces, not added them. The dots positions should always be at the end of a sentence - so after all the brackets. I changed the positions so that everything is written in the same style.

I also think "results ... is" is a grammatical mistake, that's why I changed it to "result ... is".

All of the above combined adds no value to the code, but the way the messages are written matters as well. I am pleased that people put effort in nice messages and correct grammar in this project, so I wanted to make a small contribution myself. Details are important as well.

Please reconsider.

fanquake commented at 4:12 AM on August 12, 2019: member

Thanks, however the project is overwhelmed with PRs, and is focusing on those with a higher-impact.

Please consider looking at the good first issue list if you are looking for ways to contribute.

If you are considering further trivial PRs, please at least make sure they are immediately mergeable. i.e use a more descriptive commit "docs: unified argument descriptions in bitcoin-cli.cpp".

fanquake closed this on Aug 12, 2019

MarcoFalke locked this on Dec 16, 2021