-
Notifications
You must be signed in to change notification settings - Fork 311
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
Add missing cli.rs
docs and TODOs for missing_docs
#194
Merged
notmandatory
merged 5 commits into
bitcoindevkit:missing_docs
from
notmandatory:missing_docs
Dec 1, 2020
Merged
Add missing cli.rs
docs and TODOs for missing_docs
#194
notmandatory
merged 5 commits into
bitcoindevkit:missing_docs
from
notmandatory:missing_docs
Dec 1, 2020
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
notmandatory
changed the title
Add missing rust docs and enable error(missing_docs) lint
Add missing cli module docs and enable warning(missing_docs) lint
Nov 25, 2020
notmandatory
changed the title
Add missing cli module docs and enable warning(missing_docs) lint
Add missing Nov 25, 2020
cli.rs
docs and enable warning(missing_docs) lint
notmandatory
changed the title
Add missing
Add missing Nov 25, 2020
cli.rs
docs and enable warning(missing_docs) lintcli.rs
docs and enable warning(missing_docs)
lint
notmandatory
force-pushed
the
missing_docs
branch
from
November 25, 2020 19:36
d24ccb9
to
12592bb
Compare
justinmoon
reviewed
Nov 25, 2020
justinmoon
reviewed
Nov 25, 2020
notmandatory
force-pushed
the
missing_docs
branch
from
November 26, 2020 06:41
12592bb
to
14da9f8
Compare
RCasatta
reviewed
Nov 27, 2020
RCasatta
reviewed
Nov 27, 2020
You can see an example at
https://github.com/shesek/bwt/blob/master/src/config.rs
…On Fri, Nov 27, 2020, 20:02 Steve Myers ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In src/cli.rs
<#194 (comment)>:
> +/// | Sub-command | Description |
+/// |--------------------|----------------------------------------------- |
+/// | broadcast | Broadcasts a transaction to the network. Takes either a raw transaction or a PSBT to extract |
+/// | bump_fee | Bumps the fees of an RBF transaction |
+/// | combine_psbt | Combines multiple PSBTs into one |
+/// | create_tx | Creates a new unsigned tranasaction |
+/// | extract_psbt | Extracts a raw transaction from a PSBT |
+/// | finalize_psbt | Finalizes a psbt |
+/// | get_balance | Returns the current wallet balance |
+/// | get_new_address | Generates a new external address |
+/// | help | Prints this message or the help of the given subcommand(s) |
+/// | list_transactions | Lists all the incoming and outgoing transactions of the wallet |
+/// | list_unspent | Lists the available spendable UTXOs |
+/// | policies | Returns the available spending policies for the descriptor |
+/// | public_descriptor | Returns the public version of the wallet's descriptor(s) |
+/// | repl | Opens an interactive shell |
+/// | sign | Signs and tries to finalize a PSBT |
+/// | sync | Syncs with the chosen Electrum server |
@RCasatta <https://github.com/RCasatta> oh nice idea, anything that will
make keeping docs in sync we should do. I'll try using a structopt so we
can see what it looks like.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#194 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAGWKUFTTBYI77LJWNBUNB3SR7STLANCNFSM4UCZUZZQ>
.
|
notmandatory
force-pushed
the
missing_docs
branch
from
November 28, 2020 23:47
14da9f8
to
1b2d639
Compare
notmandatory
force-pushed
the
missing_docs
branch
from
November 28, 2020 23:49
1b2d639
to
e62bb08
Compare
notmandatory
force-pushed
the
missing_docs
branch
from
December 1, 2020 07:08
c6503e3
to
86dba50
Compare
notmandatory
changed the title
Add missing
Add missing Dec 1, 2020
cli.rs
docs and enable warning(missing_docs)
lintcli.rs
docs and TODOs for missing_docs
notmandatory
force-pushed
the
missing_docs
branch
from
December 1, 2020 07:18
86dba50
to
6becc8d
Compare
This was referenced Dec 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
structopt
(instead of justclap
) and add docsPartial work for #192 .