-
Notifications
You must be signed in to change notification settings - Fork 0
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
Typos and improvement help and messages #85
Comments
First error (
Fixes are in commit 709830a. |
I've got all the above. Letting this issue open to add other small notes of the kind. |
The _ Relatively to the new _ |
All done in commit 7166bef. |
Done, will be uploaded in the next update. |
Regarding your reply here, maybe we can include that info into the _ |
You're correct, the TOKEN positional argument was missing as mandatory, I added it for the next update. Second addition also makes sense, added it. |
I still don't understand the meaning of the word |
A card (short form for CardTransfer) is an unit used for any kind of token transaction (issuance, transfer or burn transaction). There can however be more than one card in one Slimcoin transaction. For example when you transfer tokens to two recipients, this will be counted as two cards/CardTransfers. |
I've got the meaning now. Wouldn't it make sense to change
Maybe we can edit it into `Error: Final deadline for the burn or gateway transactions of this token is the block 505942.'? |
The previous post has become too long. I'm opening a new one.
However if I run the same commands without the |
I'm beginning with another post, since the previous one was becoming too long to manage. _ _ The
podtoken electorate -h output still refers to the proposal electorate (which is the old command)._ |
I'm currenlty working on the first long batch of suggestions (on a whole I agree with them and have modified the docstrings accordingly) and stumbled upon this, which is a misunderstanding:
Burning coins is "neutral", a burn transaction is valid for all PoB token decks. It even gives you proof-of-burn "score" for the slimcoin algorithm. It doesn't matter if you use the pacli command or Another comment: In reality I like the token (deck) wording more, because token/deck would suggest that token is a complete synonym for deck. It is true that token commands can replace deck commands but the other way around is not true. I'll try to be consistent with that wording though. at_address is used because it is a system parameter of this dictionary. It stands both for gateway and burn address.
Local labels have always priority so this will not occur. When the label is first stored when deck is initialized, the code checks for local labels if they exist, and if not it puts out a message inviting the user to select the deck's label himself. Some other suggestions were already solved (e.g. the ambiguity of -d in attoken claim and the local labels support in receiver lists of the claim commands) |
In the next update most suggestions of the "big" batches from August 1 and 8 were implemented, with the following exceptions:
|
Of course, I've realized it later on.
Agreed
I see now. Does it mean that it's not possible to change that parameter in the dictionary at all? If not so, i.e. if it's changeable, I think it would make sense replacing it with some more expressive word both for the AT and PoB tokens.
I'm not sure it works like described above for the moment or maybe I've taken wrong the context we are speaking about.
So I was not asked to chose the label, the deck's global label was chosen automatically as local label.
_
is a reply to this:
_
But actually the issue was different in this case: I should've used the
If not it's like we are supplying the user with too much info in just one message: he may be potentially never interested in the other option we are informing him about. |
It is not "impossible" but currently what's being output is the original structure of the object. For future versions there may be a "ELI5" interface.
I see now, my answer there was misleading. Yes, the deck init stores the global name if possible and only if there is a conflicting local label then the message about storing a label manually is print out. Regarding the three items you thought I'd not "answered": I will not comment on all small decisions I do regarding these messages. Normally if I don't comment on them I've implemented them at least partly, not necessarily "exactly" like you proposed. These are not things we have to discuss every time. But here are the answers:
For Regarding the I'll normally not provide an error message for users using the commands incorrectly. There are potentially thousands of possible messages that would have been implemented in this case. In some cases however you already saw I did implement a message. This is the case when I have to catch a system error, where otherwise a long traceback is shown which will confuse the user. But then the messages will be very simple and generic. So in the case with Yes I'm maybe a bit salty again but it's always the same problem with some of your proposals. I can't hold the hand of the user all the time if he's not willing to read about the correct usage, much less with the Fire/pacli package which is normally meant for advanced/technical users. What I've done to clarify is that I've changed the message to The same goes for the issue with the
I've already commented on this in the podtoken electorate issue. Makes no sense because why should the user enter |
I've understood that you are using this approach, but in the three cases I've mentioned I haven't found the way to understand what have been changed, that's why I've asked.
Would it make sense to document this change somewhere in the
You are right, I've probably confused that my proposal with this one:
If possible it may be useful to change the line
Then I'm doing something wrong on my end, because when I try to run
This was enlightening for me, TBH. I haven't thought about it that way so far. Thank you.
I think it should be edited somehow, because there are two verbs in it so the meaning is a bit obscure, and also it doesn't seem that clear that we are speaking about the epoch following the current one. |
I'm creating this new post, since the previous one has become a bit long to manage. |
I've decided to create this issue so in case there are typos or improvements to make in the help we can put everything here, so it doesn't interfere with the main testing process.
Right now I've found the following typo in
transaction list
help:Seems like almost the same text is included into this line twice, probably the second sentence is the old one.
_
If it can be useful I've found another one in the
card list
help.In the description sections is written:
While if I've got it right in the
card list
command has becometoken transfers
command._
token transfers
help there is the following line:I don't know whether it's relevant in that context.
_
In the
token list
help there is the following explanation about the-o
flag:However the both the
token list -o
and thetoken list -o -d
commands output the same number of decks. I assume the-p
flag was formerly-d
in this case and the description wasn't changed after the change.By the way the
token list -o -b
seems to work as well. Maybe we should mention that in the-o
flag description as well?I've also discovered that there is no P2TH address in the
token list
output. Thus it's not clear what is being this flag's output compared to (it's not something extracted from thetoken list
output, for instance). I think I know what is the meaning though - the flag probably means p2th-addresses-only, but by putting "only" ahead of "p2th" the meaning seems to become less evident. For that reason I'd suggest us to consider the-l
flag which would mean--list-p2th-addresses-of-the-decks
. What do you think?_
Like in the issue #87 there is no difference between
token list
,token list -d
,token list -q
andtoken list -d -q
, which is probably expected._
As mentioned here I'd suggest to add an additional information into the
transaction list
's-l
description. Something like: "The flag grants a quicker output in case the blocks were stored using deck/token cache/init or address cache commands previously, otherwise it will be ignored"._
The
pacli token balances [ADDRESS|-w]
usage mode description states:It seems to me to remember that previously it was mentioning that this usage mode outputs the main dPoD and PoB desks info only.
_
The
-a
flag output for thetoken balances [ADDRESS|-w] -t DECK
usage mode is the same as without the-a
flag. Would it make sense to edit the-a
flag description fromSee above. Shows balances of all tokens in JSON format. Not in combination with -o.
intoSee above. Shows balances of all tokens in JSON format. Not in combination with -o and -t.
?The text was updated successfully, but these errors were encountered: