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.

Sign up for GitHub

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

Jump to bottom

rpcdoc: Remove redundant type from description #18258

Closed
maflcko opened this issue Mar 4, 2020 · 1 comment · Fixed by #18268
Closed

rpcdoc: Remove redundant type from description #18258

maflcko opened this issue Mar 4, 2020 · 1 comment · Fixed by #18268
Labels
Docs good first issue

Comments

@maflcko
Copy link
Member

maflcko commented Mar 4, 2020

The RPC docs are now enforced to specify the json type of the args and results at compile time. However, some help texts contain the type twice. (E.g. #17809 (comment) ). The duplicate type in the description should be removed.

Duplicates can be found with this command:

git grep --extended-regexp  'RPC.*(ARR|OBJ).*json (array|object)' src/rpc/ src/wallet/rpc*

Useful skills:

Basic understanding of how to compile and run Bitcoin Core.

Want to work on this issue?

The purpose of the good first issue label is to highlight which issues are suitable for a new contributor without a deep understanding of the codebase.

You do not need to request permission to start working on this. You are encouraged to comment on the issue if you are planning to work on it. This will help other contributors monitor which issues are actively being addressed and is also an effective way to request assistance if and when you need it.

For guidance on contributing, please read CONTRIBUTING.md before opening your pull request.
@maflcko maflcko mentioned this issue Mar 4, 2020
Merged
This was referenced Mar 5, 2020
Merged
Merged
@yashpatel20
Copy link

I am working on it

@docallag docallag mentioned this issue Mar 5, 2020
Merged
sidhujag pushed a commit to syscoin/syscoin that referenced this issue Mar 11, 2020
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
e8d4a13 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
sidhujag pushed a commit to syscoin-core/syscoin that referenced this issue Nov 10, 2020
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
bf7a419 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Sep 20, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
7f3aa20 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 14, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
acd86b5 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 18, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
8526fbb 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 19, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
56bf9d5 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 26, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
3c6cdbd 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 27, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
186d489 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 28, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
6dad2b3 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this issue Dec 30, 2022
@vijaydasmp
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
22ed9ae 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
PastaPastaPasta pushed a commit to vijaydasmp/dash that referenced this issue Jan 20, 2023
@PastaPastaPasta
Merge bitcoin#18268: rpc: Remove redundant types from descriptions
1093333 
8a2a652 Remove redundant type information from rpc docs (David O'Callaghan)

Pull request description:

  Simple edit of the RPC calls to remove redundant text ("A json object/array ...") from the beginning of help.

  Fixes: bitcoin#18258

Top commit has no ACKs.

Tree-SHA512: cbbf760e0b7b4eda61c40b420ed77f5d878318e37b0eb13e63567212240b2c4ecc15d84030e98075e21c9ae9016539adfd201e5661ea824166a76d335180c32f
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Docs good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rpc: Remove redundant types from descriptions docallag/bitcoin
2 participants
@maflcko @yashpatel20