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

help strings for subcommands #105

Merged
merged 13 commits into from
Mar 16, 2022
Merged

help strings for subcommands #105

merged 13 commits into from
Mar 16, 2022

Conversation

jl-animo
Copy link
Contributor

Note

  • Please review all help strings
  • Please halp with missing help strings (free free to commit to this PR)

@jl-animo jl-animo force-pushed the feat/all-the-help-strings branch from 9dcf65b to fbc50f8 Compare March 15, 2022 11:25
"Print a QR code, convenient for use with mobile apps"
}
// TODO: Find out what "toolbox" is
HelpStrings::ConnectionsInviteToolbox => "????",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Toolbox is basically Aries-gui :). This creates a toolbox specific invite

alias = toolbox
multi-use = false
auto-accept = true

and the body contains metadata that the toolbox should be admin

"A credential definition to base the credential on"
}
// TODO: What dis?
HelpStrings::CredentialsOfferKey => "????",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A credential has attributes as keyvalue

name: Jean Claude Van Damme
age: 10000000
...

age is here the credentialofferkey and 10000 is here the credentialoffervalue

// TODO: What dis?
HelpStrings::CredentialsPropose => "????",
// TODO: What dis?
HelpStrings::CredentialsProposeId => "????",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not too sure hahaha

// TODO: What dis?
HelpStrings::CredentialsOfferValue => "????",
// TODO: What dis?
HelpStrings::CredentialsPropose => "????",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not implemented yet, but it is another way to start an issue-credential flow.

You can propose a credential to me that I should give you. (so you ask the bank for a credential with your name, etc. in the proposal if I am not mistaken)

HelpStrings::SchemaCreateName => "Name of the schema",
HelpStrings::SchemaCreateVersion => "Version of of the schema, useful to be able to specify multiple versions of the same schema",
// TODO: What dis?
HelpStrings::SchemaCreateAttributes => "????",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A credential is based on the structure of a schema.

so like before the credentialofferkeys are basically the same as the schema attributes (name, age, birthday, etc...)

@berendsliedrecht
Copy link
Member

@jl-animo I left some comments on your todos :)

@jloleysens
Copy link
Contributor

@blu3beri ready for round 2

}
}
}

const HELP_STRING_CONNECTIONS_INVITE_TOOLBOX: &str = "Short-hand to create an invitation for the Aries Toolbox that sets:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the line after the quote be on a new line? or does that ruin the printing? (its nicely formatted then in the code

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah unfortunately this messes with the formatting when printed :(

Copy link
Member

@berendsliedrecht berendsliedrecht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 minor comments, after those are resolved we can merge

@jloleysens jloleysens merged commit 31741ed into main Mar 16, 2022
@jloleysens jloleysens deleted the feat/all-the-help-strings branch March 16, 2022 14:18
@jloleysens jloleysens mentioned this pull request Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants