[doc] Add hint about getmempoolentry to getrawmempool help. #10310

pull kallewoof wants to merge 1 commits into bitcoin:master from kallewoof:doc-getrawmempool-getmempoolentry changing 1 files +1 −0
  1. kallewoof commented at 12:42 AM on May 2, 2017: member

    Lots of people seem to be unaware that getmempoolentry even exists (myself included, before today; see #10300 & #10304), so adding a hint to getrawmempool seems warranted.

    I was tempted to start adding "See also: ..." strings to all RPC commands but wasn't sure that was generally desired.

  2. kallewoof force-pushed on May 2, 2017
  3. fanquake added the label Docs and Output on May 2, 2017
  4. fanquake added the label RPC/REST/ZMQ on May 2, 2017
  5. junderw commented at 10:19 AM on May 2, 2017: contributor

    utACK 41bc5ba

    TIL

  6. jonasschnelli commented at 1:04 PM on May 2, 2017: contributor

    Yes. Adding a hint makes sense. Though I'm not sure if we should add it below the RPC/curl info. What speaks against mentioning getmempoolentry in the description?

  7. instagibbs commented at 5:56 PM on May 2, 2017: member

    agreed @jonasschnelli I think just putting that in the main body of help is best.

    I might stop reading by the examples...

  8. jnewbery commented at 9:02 PM on May 2, 2017: member

    I agree with the others. The hint should be further up, between the main text and the arguments listing.

    Otherwise utACK

  9. kallewoof force-pushed on May 4, 2017
  10. kallewoof commented at 12:11 PM on May 4, 2017: member

    Moved hint to below description. Should it be a part of it (i.e. no space)? Below is current output:

    $ ./bitcoin-cli -regtest help getrawmempool
    getrawmempool ( verbose )
    
    Returns all transaction ids in memory pool as a json array of string transaction ids.
    
    Hint: use getmempoolentry to fetch a specific transaction from the mempool.
    
    Arguments:
    1. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids
    
    Result: (for verbose = false):
    [                     (json array of string)
      "transactionid"     (string) The transaction id
      ,...
    ]
    
    Result: (for verbose = true):
    {                           (json object)
      "transactionid" : {       (json object)
    [omitted]
    }
    
    Examples:
    > bitcoin-cli getrawmempool true
    > curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawmempool", "params": [true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
    
    $ 
    
  11. instagibbs commented at 12:14 PM on May 4, 2017: member

    utACK

  12. [doc] Add hint about getmempoolentry to getrawmempool help. 3a0a5bc234
  13. kallewoof force-pushed on May 6, 2017
  14. kallewoof commented at 3:52 AM on May 6, 2017: member

    Apologies; re-committed verified, same as 06eb5a7.

  15. sdaftuar commented at 5:07 PM on May 8, 2017: member

    utACK

  16. MarcoFalke merged this on May 8, 2017
  17. MarcoFalke closed this on May 8, 2017

  18. MarcoFalke referenced this in commit f4b15e2de9 on May 8, 2017
  19. kallewoof deleted the branch on May 9, 2017
  20. luke-jr referenced this in commit b88a6d1f49 on Jun 3, 2017
  21. luke-jr referenced this in commit 4207fe05c0 on Jun 3, 2017
  22. luke-jr referenced this in commit 481f7058d1 on Jun 3, 2017
  23. luke-jr referenced this in commit 535f222db6 on Jun 5, 2017
  24. luke-jr referenced this in commit adb9b88d6a on Jun 5, 2017
  25. luke-jr referenced this in commit ff274d3b00 on Jun 5, 2017
  26. nomnombtc referenced this in commit 88f8f68a21 on Jul 17, 2017
  27. codablock referenced this in commit 12770beb6b on Jan 26, 2018
  28. andvgal referenced this in commit 0b89963914 on Jan 6, 2019
  29. lateminer referenced this in commit 32e354be52 on Jan 11, 2019
  30. CryptoCentric referenced this in commit 6b9ad94125 on Feb 27, 2019
  31. Mengerian referenced this in commit ddf1476fa9 on Jul 2, 2019
  32. jonspock referenced this in commit 6b9304c6c4 on Aug 27, 2019
  33. jonspock referenced this in commit a0cf40c57d on Aug 28, 2019
  34. DrahtBot locked this on Sep 8, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 15:15 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me