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

feat: add examples of multiple coins for command-line interfaces #155

Closed
4 tasks
jaybxyz opened this issue Oct 5, 2021 · 0 comments · Fixed by #156
Closed
4 tasks

feat: add examples of multiple coins for command-line interfaces #155

jaybxyz opened this issue Oct 5, 2021 · 0 comments · Fixed by #156
Assignees
Labels
enhancement New feature or request

Comments

@jaybxyz
Copy link
Contributor

jaybxyz commented Oct 5, 2021

Summary

This issue requests to improve command-line interfaces by updating descriptions to have more contexts and providing more examples to make better developer-friendly environment. For example, NewUnstakeCmd accepts sdk.Coins type, and it only provides an example of a single coin. Developers who first read the description and the example won't know if it accepts multiple coins. It will be better to have an example of how to use multiple coins for the developers.

Proposal

We should add more examples on certain command-line interfaces to provide developer-friendly environment. Devs who first get to know about the farming module and play with it will be better off to know how to use each command if they have solid descriptions and more examples.

Tasks

  • Add NewUnstakeCmd() multiple coins example and add test case for it
  • Add NewStakeCmd() multiple coins example and add test case for it
  • Add NewHarvestCmd() more examples and add test cases for it
  • Add more description on NewAdvanceEpochCmd()
  • Update the link in the description to point to the correct location

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@jaybxyz jaybxyz added the enhancement New feature or request label Oct 5, 2021
@jaybxyz jaybxyz added this to the Farming F1 v1.0 milestone Oct 5, 2021
@jaybxyz jaybxyz self-assigned this Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant