Consistency fixes for RPC descriptions#14373
Merged
maflcko merged 1 commit intobitcoin:masterfrom Oct 10, 2018
Merged
Conversation
jimmysong
reviewed
Oct 3, 2018
Contributor
jimmysong
left a comment
jimmysong
left a comment
There was a problem hiding this comment.
It would be nice to get all the capitalizations consistent as well. Sometimes the description for a hash result will say "The block hash" others will say "the block hash".
Member
|
The formatting fixes would be more elegantly solved with a helper class that takes care of the formatting: See #14378 |
Contributor
|
Contributor
Author
|
Also:
should be added to the docgen / its checker |
Member
|
Please squash your commits, and we can merge this in. Moving forward we're likely to be generating this kind of documentation, so that styling can remain consistent. |
ch4ot1c
force-pushed
the
fix/rpc-descriptions
branch
from
942952d to
a28dfe4
Compare
'Must be one of' should always end in a ':' 'hex encoded' is now always 'hex-encoded' Remove redundant '(defaults to CONSERVATIVE)' text from estimatesmartfee Consistent spacing for options '( verbose )' and '( verbosity )' 'BIP125 replaceable' is now always 'BIP125-replaceable' JSON-RPC example is now always 'As a JSON-RPC call'
ch4ot1c
force-pushed
the
fix/rpc-descriptions
branch
from
a28dfe4 to
b8edb98
Compare
Contributor
Author
|
Squashed |
Member
|
utACK b8edb98 |
Contributor
|
utACK b8edb98 |
Contributor
|
It would be nice to have a plan for this consistency/cleanup/format etc. There is nothing in place to prevent adding the same inconsistencies. As it is I'm -0. |
Contributor
Member
maflcko
pushed a commit
that referenced
this pull request
Oct 10, 2018
b8edb98 [rpc] Descriptions: Textual consistency fixes (Jon Layton) Pull request description: Tree-SHA512: fa22ddac94e95672579cc84309f1c3ea3a2dbf762e45a8ae9c121c4c5188bf8c19ff9458d49dd7ef760c3ae4226487612a2954e9a1a0e8b720116afeb718b46b
Contributor
|
Alrighty then 👍 |
Contributor
|
Missed |
deadalnix
pushed a commit
to Bitcoin-ABC/bitcoin-abc
that referenced
this pull request
Mar 20, 2020
Summary: b8edb9810a [rpc] Descriptions: Textual consistency fixes (Jon Layton) Pull request description: Tree-SHA512: fa22ddac94e95672579cc84309f1c3ea3a2dbf762e45a8ae9c121c4c5188bf8c19ff9458d49dd7ef760c3ae4226487612a2954e9a1a0e8b720116afeb718b46b Backport of Core [[bitcoin/bitcoin#14373 | PR14373]] Test Plan: ninja ninja check ./bitcoind ./bitcoin-cli help <changed rpcs> Verify changes in help text. Reviewers: O1 Bitcoin ABC, #bitcoin_abc, deadalnix Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, deadalnix Differential Revision: https://reviews.bitcoinabc.org/D5517
ftrader
pushed a commit
to bitcoin-cash-node/bitcoin-cash-node
that referenced
this pull request
May 19, 2020
Summary: b8edb9810a [rpc] Descriptions: Textual consistency fixes (Jon Layton) Pull request description: Tree-SHA512: fa22ddac94e95672579cc84309f1c3ea3a2dbf762e45a8ae9c121c4c5188bf8c19ff9458d49dd7ef760c3ae4226487612a2954e9a1a0e8b720116afeb718b46b Backport of Core [[bitcoin/bitcoin#14373 | PR14373]] Test Plan: ninja ninja check ./bitcoind ./bitcoin-cli help <changed rpcs> Verify changes in help text. Reviewers: O1 Bitcoin ABC, #bitcoin_abc, deadalnix Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, deadalnix Differential Revision: https://reviews.bitcoinabc.org/D5517
Munkybooty
pushed a commit
to Munkybooty/dash
that referenced
this pull request
Jul 21, 2021
b8edb98 [rpc] Descriptions: Textual consistency fixes (Jon Layton) Pull request description: Tree-SHA512: fa22ddac94e95672579cc84309f1c3ea3a2dbf762e45a8ae9c121c4c5188bf8c19ff9458d49dd7ef760c3ae4226487612a2954e9a1a0e8b720116afeb718b46b
Munkybooty
pushed a commit
to Munkybooty/dash
that referenced
this pull request
Jul 23, 2021
b8edb98 [rpc] Descriptions: Textual consistency fixes (Jon Layton) Pull request description: Tree-SHA512: fa22ddac94e95672579cc84309f1c3ea3a2dbf762e45a8ae9c121c4c5188bf8c19ff9458d49dd7ef760c3ae4226487612a2954e9a1a0e8b720116afeb718b46b
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
9 participants
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.
No description provided.