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

docs: Added staking client docs. #10306

Merged
merged 13 commits into from
Oct 12, 2021
Merged

Conversation

juggernaut09
Copy link
Contributor

@juggernaut09 juggernaut09 commented Oct 5, 2021

Description

Closes: #10292


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Copy link
Collaborator

@anilcse anilcse left a comment

Choose a reason for hiding this comment

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

Looks like this is covering only queries. Can you add tx commands too?

x/staking/spec/09_client.md Outdated Show resolved Hide resolved
@barriebyron
Copy link
Contributor

@juggernaut09 thank you for your contribution, did you want a review? You can move the PR from draft to Ready for Review
wdyt @soniasingla ?

@juggernaut09 juggernaut09 marked this pull request as ready for review October 7, 2021 02:35
@juggernaut09
Copy link
Contributor Author

Hi @barriebyron, I would like to add grpc and REST clients docs as well. In the Interim, Please review the CLI Client commands.

Regards.

Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

hi @juggernaut09 thank you for this fine work! I did not review for technical accuracy, but did make suggestions for editorial fixes. Do you know about adding the changes in batch? see https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request

x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
x/staking/spec/09_client.md Outdated Show resolved Hide resolved
@juggernaut09
Copy link
Contributor Author

Hi @barriebyron , I have resolved the above mentioned suggestions in this commit.

@barriebyron barriebyron self-requested a review October 7, 2021 15:25
Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

Editorial approval from me, thanks @juggernaut09
However, I cannot approve technical content and leave that review to the codeowners

thanks everyone!

@tac0turtle
Copy link
Member

hey, thanks for the contribution!! It looks good.

nit: Could you add some docs on rest and/or grpc?

@juggernaut09
Copy link
Contributor Author

Hi, @marbar3778. Thanks for reviewing. I have added the gRPC docs in this commit. I will add the REST docs in the further commits. Interim please review the gRPC docs.

Regards.

@tac0turtle
Copy link
Member

looks good!! thank you for making the change so quickly.

@juggernaut09
Copy link
Contributor Author

Hi, @barriebyron @marbar3778 @aaronc @alexanderbez @anilcse .Added the CLI, gRPC and REST client docs for staking module in this commit. Please review it.

Regards.

@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 12, 2021
@mergify mergify bot merged commit 6983824 into cosmos:master Oct 12, 2021
yun-yeo pushed a commit to yun-yeo/cosmos-sdk that referenced this pull request Oct 12, 2021
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: cosmos#10292 

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
@barriebyron
Copy link
Contributor

congratulations @juggernaut09, be sure to fill out the Contributor Details form to order your swag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:x/staking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: staking module add CLI examples to client.md in the spec/ directory
5 participants