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: improve keyring package docs #13835

Merged
merged 2 commits into from
Nov 10, 2022
Merged

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Nov 10, 2022

Improve Keyring docs

@rootulp rootulp changed the title fix: keyring docs docs: improve keyring package docs Nov 10, 2022
@@ -21,20 +21,20 @@
//
// The backends:
//
// os The instance returned by this constructor uses the operating system's default
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the whitespace changes look odd but they render better

Before After
before after

@@ -1,9 +1,9 @@
// Package keys provides common key management API.
// Package keyring provides common key management API.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this doc was originally written when the package was named keys but the package has since been renamed

Ref: #5833

@rootulp rootulp marked this pull request as ready for review November 10, 2022 20:07
@rootulp rootulp requested a review from a team as a code owner November 10, 2022 20:07
@codecov
Copy link

codecov bot commented Nov 10, 2022

Codecov Report

Merging #13835 (2d2c44a) into main (f001b46) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #13835      +/-   ##
==========================================
- Coverage   56.75%   56.73%   -0.03%     
==========================================
  Files         637      637              
  Lines       54722    54722              
==========================================
- Hits        31057    31046      -11     
- Misses      21151    21164      +13     
+ Partials     2514     2512       -2     
Impacted Files Coverage Δ
x/distribution/simulation/operations.go 80.64% <0.00%> (-9.68%) ⬇️
x/group/keeper/keeper.go 56.64% <0.00%> (+0.39%) ⬆️
x/staking/simulation/operations.go 75.91% <0.00%> (+1.37%) ⬆️

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! Thank you!

@julienrbrt julienrbrt merged commit 4ff588d into cosmos:main Nov 10, 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.

2 participants