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

Fix typos in command descriptions #760

Open
f0dc343395 opened this issue Dec 9, 2020 · 3 comments
Open

Fix typos in command descriptions #760

f0dc343395 opened this issue Dec 9, 2020 · 3 comments

Comments

@f0dc343395
Copy link

f0dc343395 commented Dec 9, 2020

A multi line string literal should be used to fix these typos. And example of a typo coming from this is utxoduring from line 59 and 60.

description="For creating multiple utxos from one (for commitments in JM)."
"Provide a utxo in form txid:N that has some unspent coins;"
"Specify a list of destination addresses and the coins will"
"be split equally between them (after bitcoin fees)."
"You'll be prompted to enter the private key for the utxo"
"during the run; it must be in WIF compressed format."
"After the transaction is completed, the utxo strings for"
"the new outputs will be shown."
"Note that these utxos will not be ready for use as external"
"commitments in Joinmarket until 5 confirmations have passed."
" BE CAREFUL about handling private keys!"
" Don't do this in insecure environments."
" Works only with p2pkh ('1') or p2sh-p2wpkh (segwit '3')"
" utxos - set segwit=False in the POLICY section of"
" joinmarket.cfg for the former."

@AdamISZ
Copy link
Member

AdamISZ commented Dec 9, 2020

Thanks, agreed.

@AdamISZ
Copy link
Member

AdamISZ commented Jan 20, 2021

The most egregious example of bad formatting was fixed in #783 (it is less trivial than you'd think - see that commit for why, basically optparse munges newlines so a multiline string is not quite enough).

I'll make a PR to fix all the others at some point, unless someone else wants to, using the same trick as in #783.

@nlightenme
Copy link

This looks like it was fixed in #806

As far as I can see the other scripts use multiline string literals now also?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants