Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "debug" rpc help text #2810

Merged
merged 3 commits into from
Mar 28, 2019
Merged

Update "debug" rpc help text #2810

merged 3 commits into from
Mar 28, 2019

Conversation

UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Mar 27, 2019

Format help text to match current "template" a bit better:

  • add Arguments and Result sections;
  • category is not optional, should not be surrounded by ().

Also update debug categories list here to match the one in init.cpp while at it.

Thanks @thephez for pointing out.

@UdjinM6 UdjinM6 added the RPC Some notable changes to RPC params/behaviour/descriptions label Mar 27, 2019
@UdjinM6 UdjinM6 added this to the 14.0 milestone Mar 27, 2019
@thephez
Copy link
Collaborator

thephez commented Mar 27, 2019

A couple thoughts that may or may not be helpful 🙂

  1. It might be nice to return the full list of debug categories enabled instead of the one just added? Not sure if that would be helpful or not.
  2. It doesn't validate the category so you can enter anything and will never get an error. Could cause confusion for typos if the category is invalid.

@thephez
Copy link
Collaborator

thephez commented Mar 27, 2019

Oh, also tACK 👍

@UdjinM6
Copy link
Author

UdjinM6 commented Mar 27, 2019

@thephez

  1. Categories aren't added, they are replaced. If you need many categories you have to specify them all at once.
  2. True but debug a (or some another non-existing category) is also helpful if you want to enable branches with if (fDebug) but don't want the spam from anything else for example ;) Maybe result could be a bit more explicit about this specific case though, I added a note. We could probably add some verification logic here later when debug categories will become enum.

@thephez
Copy link
Collaborator

thephez commented Mar 27, 2019

re-ACK

thephez added a commit to thephez/dash-docs that referenced this pull request Mar 27, 2019
Copy link

@codablock codablock left a comment

Choose a reason for hiding this comment

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

utACK

@UdjinM6 UdjinM6 merged commit 8987a6c into dashpay:develop Mar 28, 2019
thephez added a commit to dash-docs/dash-docs that referenced this pull request Mar 28, 2019
* RPC - Update debug category list
 Related to dashpay/dash#2810

* RPC - Coin age priority updates
 - Remove estimate*priority
 - Remove priority param from prioritisetransactions
 - Adjust relay-fee param descriptions

* Formatting - Minor fixes

* Content - Sync guide and glossary with priority changes
thephez added a commit to thephez/dash-docs that referenced this pull request May 17, 2019
* RPC - Update debug category list
 Related to dashpay/dash#2810

* RPC - Coin age priority updates
 - Remove estimate*priority
 - Remove priority param from prioritisetransactions
 - Adjust relay-fee param descriptions

* Formatting - Minor fixes

* Content - Sync guide and glossary with priority changes
thephez added a commit to dash-docs/dash-docs that referenced this pull request May 17, 2019
* RPC - Update debug category list
 Related to dashpay/dash#2810

* RPC - Coin age priority updates
 - Remove estimate*priority
 - Remove priority param from prioritisetransactions
 - Adjust relay-fee param descriptions

* Formatting - Minor fixes

* Content - Sync guide and glossary with priority changes
@UdjinM6 UdjinM6 deleted the rpcdebughelp branch November 26, 2020 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RPC Some notable changes to RPC params/behaviour/descriptions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants