Make Style of RPC Documentation Consistent #14894

1. 
   nopara73 commented at 4:59 pm on December 7, 2018: none

   I noticed RPC documentation is a bit inconsistent. Sometimes there is period at the end of the sentence, sometimes there is not, etc… so I thought I open an up for grab issue that does not require any coding skills.

   As a starting point, I selected out 6 reasonable recommendation from .NET Error Message Guidelines those could make the style more consistent:

   • Use complete but simple sentences.
   • Use correct capitalization.
   • End each sentence in a period.
   • Avoid uppercase text and exclamation points.
   • Do not anthropomorphize. Do not imply that programs or hardware can think or feel.
   • Do not use colloquial words or phrases. Do not use terms that may be offensive in certain cultures.
   • Avoid the word “please”. It can be interpreted to mean that a required action is optional.
2. maflcko added the label Docs on Dec 7, 2018
3. maflcko added the label RPC/REST/ZMQ on Dec 7, 2018
4. maflcko added the label Brainstorming on Dec 7, 2018
5. 
   Sjors commented at 6:53 pm on December 9, 2018: member

   See also the work on RPCHelpMan, e.g. #14726, #14875 and #14885. Some of this could be enforced by a linter, but otherwise should go in the RPC section of Developer Notes.
6. 
   laanwj commented at 1:05 pm on December 13, 2018: member

   but otherwise should go in the RPC section of Developer Notes.

   Even if checked by a linter it should probably go there :-)

7. 
   ch4ot1c commented at 5:09 pm on December 14, 2018: contributor

   Ack
8. 
   blueredpen commented at 1:56 am on December 30, 2021: none

   Looking into this issue.
9. 
   maflcko commented at 2:38 pm on August 14, 2022: member

   If this is done, then it should be enforced inside the help manager. Otherwise people will remove periods after they have been added, see https://github.com/bitcoin/bitcoin/pull/25420
10. 
    pinheadmz commented at 2:01 pm on April 27, 2023: member

    This issue is unlikely to be fixed in Bitcoin Core. We’ll close for now, but feel free to open another issue or pull request with a fix.

    see https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#refactoring

11. pinheadmz closed this on Apr 27, 2023

    ---

12. bitcoin locked this on Apr 26, 2024

Contributors
nopara73 Sjors laanwj ch4ot1c blueredpen maflcko pinheadmz

Labels
Brainstorming Docs RPC/REST/ZMQ