Document RPC method aliasing #12700

1. 
   ryanofsky commented at 8:41 pm on March 15, 2018: member

   Suggested by @Sjors in #11536 (comment)
2. Document RPC method aliasing

   Suggested by Sjors Provoost <sjors@sprovoost.nl> in
   https://github.com/bitcoin/bitcoin/pull/11536#issuecomment-372820660

   4c317d89e9
3. 
   Sjors commented at 8:48 pm on March 15, 2018: member

   Concept ACK. Ideally there would also be some comment next to each alias in places like CRPCCommand commands[], but apparently that’s non trivial.
4. 
   ryanofsky commented at 8:54 pm on March 15, 2018: member

   Ideally there would also be some comment next to each alias in places like CRPCCommand commands[]

   What would the comment say, and why would it be helpful? The only non-obvious behavior I can think of regarding aliases is that they are omitted from the command listing in help text, and this doesn’t seem like a relevant fact to mention in the middle of command registration.

5. randolf approved
6. fanquake added the label Docs on Mar 15, 2018
7. fanquake added the label RPC/REST/ZMQ on Mar 15, 2018
8. 
   PierreRochard commented at 4:46 pm on March 18, 2018: contributor

   ACK 4c317d89e9d980328028ff01cd9a0465cc22bb7e
9. 
   laanwj commented at 2:58 pm on March 19, 2018: member

   utACK https://github.com/bitcoin/bitcoin/pull/12700/commits/4c317d89e9d980328028ff01cd9a0465cc22bb7e. This is exactly the behavior that is desirable for deprecating/renaming RPCs, but needs to be documented.
10. laanwj merged this on Mar 19, 2018
11. laanwj closed this on Mar 19, 2018

    ---

12. laanwj referenced this in commit ebdf84c960 on Mar 19, 2018
13. PastaPastaPasta referenced this in commit 28d8d99a2c on Jul 17, 2020
14. PastaPastaPasta referenced this in commit ea7575375d on Jul 17, 2020
15. MarcoFalke locked this on Sep 8, 2021

Contributors
ryanofsky Sjors randolf PierreRochard laanwj

Labels
Docs RPC/REST/ZMQ