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: update x/foundation documentation #802

Merged
merged 4 commits into from
Nov 22, 2022

Conversation

0Tech
Copy link
Collaborator

@0Tech 0Tech commented Nov 17, 2022

Description

This patch would update the x/foundation documentation.
It would:

  • Update the references in README.md
  • Update the descriptions in CLIs.

Checklist:

  • I followed the contributing guidelines and code of conduct.
  • I have added a relevant changelog to CHANGELOG.md
  • I have added tests to cover my changes.
  • I have updated the documentation accordingly.
  • I have updated API documentation client/docs/swagger-ui/swagger.yaml

@0Tech 0Tech self-assigned this Nov 17, 2022
@0Tech 0Tech added documentation Improvements or additions to documentation C:x/foundation x/foundation module labels Nov 17, 2022
@0Tech 0Tech marked this pull request as ready for review November 18, 2022 00:54
@codecov
Copy link

codecov bot commented Nov 21, 2022

Codecov Report

Merging #802 (b979643) into rc9/v0.46.0 (b13f437) will increase coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@               Coverage Diff               @@
##           rc9/v0.46.0     #802      +/-   ##
===============================================
+ Coverage        62.15%   62.16%   +0.01%     
===============================================
  Files              877      877              
  Lines            99419    99419              
===============================================
+ Hits             61793    61807      +14     
+ Misses           34007    33981      -26     
- Partials          3619     3631      +12     
Impacted Files Coverage Δ
x/token/token.go 50.00% <0.00%> (-50.00%) ⬇️
x/token/validation.go 67.27% <0.00%> (-1.82%) ⬇️
x/collection/msgs.go 50.44% <0.00%> (+0.74%) ⬆️
crypto/keys/internal/ecdsa/privkey.go 84.21% <0.00%> (+1.75%) ⬆️
x/token/msgs.go 50.95% <0.00%> (+4.56%) ⬆️

Copy link
Member

@tkxkd0159 tkxkd0159 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@zemyblue zemyblue left a comment

Choose a reason for hiding this comment

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

Why is this change necessary?

@0Tech
Copy link
Collaborator Author

0Tech commented Nov 22, 2022

Why is this change necessary?

It's because the descriptions on the messages MUST be updated. There was an update in the messages since the last documentation.

@0Tech 0Tech requested a review from zemyblue November 22, 2022 03:08
@0Tech 0Tech merged commit c973433 into Finschia:rc9/v0.46.0 Nov 22, 2022
@0Tech 0Tech deleted the foundation_docs branch November 22, 2022 07:35
This was referenced Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/foundation x/foundation module documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants