-
Notifications
You must be signed in to change notification settings - Fork 62
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
Flags in docs diverged from implementation #58
Comments
Oh sorry I didn't realize this in the chat, but this is actually convention across hsd and bcoin: Similar to the chart on the top here: CLI params are always dash-case ( Maybe we should add an INTRODUCTION page to the API docs that clears up some of these issues. |
That makes sense. Knew that convention on the hsd side, but didn't think it would apply, when the docs show something different, but makes sense that they show that. Probably a note in general would be helpful. Especially, when examples are shown for CLI. Closing anyway. |
Reopening to remind us we should add that intro page explaining basic conventions in the api-docs. |
TODO: Add to intro section at top of API docs that command line params are always |
The implementation in hsw-cli and most likely others moved from CamelCase to dash-case.
Example subtractFee -> subtract-fee.
This is not yet reflected within the docs:
https://hsd-dev.org/api-docs/?shell--cli#send-a-transaction
The text was updated successfully, but these errors were encountered: