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

Indicate which methods are disabled experimental features in the main zcash-cli help output. #3196

Open
nathan-at-least opened this issue Apr 20, 2018 · 0 comments
Labels
A-documentation Area: Documentation A-rpc-interface Area: RPC interface

Comments

@nathan-at-least
Copy link
Contributor

When I run zcash-cli help I get a list of many methods. Then if I run zcash-cli help $SOMEMETHOD sometimes that help text says the feature is a disabled experimental feature.

It would be nice to segregate the disabled features in the top-level help output, so that it ends with a separate section that looks something like this:

== Experimental Features ==
**Note:** Experimental Features are DISABLED

**Note:** Experimental Features provide new functionality which has received the standard review and testing of other `zcashd` features. However, they typically have not had widespread use in production and their behavior or interface may change between releases. We do not recommend using them in large scale production environments. To enable them pass `zcashd` the `-experimentalfeatures` commandline option or add `experimentalfeatures=1` to `zcash.conf`.

z_mergetoaddress ["fromaddress", ... ] "toaddress" ( fee ) ( transparent_limit ) ( shielded_limit ) ( memo )
z_fancynewthingy arg1 ( arg2 )
…

If they are enabled, the methods would appear in the appropriate section.

Another approach would be to mark them "inline" somehow whether or not they are enabled or disabled, but that seems messier to me.

@nathan-at-least nathan-at-least added the A-documentation Area: Documentation label Apr 20, 2018
@ioptio ioptio added this to Sprint Backlog in Documentation Aug 2, 2018
@daira daira added the A-rpc-interface Area: RPC interface label Dec 11, 2018
@ioptio ioptio moved this from Sprint Backlog to Product Backlog in Documentation Dec 18, 2018
@ioptio ioptio moved this from Product Backlog to Blocked/Tracking in Documentation Dec 18, 2018
@daira daira added this to Product Backlog in Arborist Team Dec 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation A-rpc-interface Area: RPC interface
Projects
Arborist Team
  
Needs Prioritization
Documentation
  
Blocked/Tracking
Development

No branches or pull requests

2 participants