-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
chore: Add x/capability docs #11922
chore: Add x/capability docs #11922
Conversation
Codecov Report
@@ Coverage Diff @@
## main #11922 +/- ##
==========================================
- Coverage 66.02% 66.00% -0.02%
==========================================
Files 676 675 -1
Lines 71346 71282 -64
==========================================
- Hits 47105 47053 -52
+ Misses 21559 21551 -8
+ Partials 2682 2678 -4
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would love to see the entire spec and doc under a single README
. WDYT? We've done this for some modules afaik.
I don't see any other module doing everything in a single file, at least in the ones in this repo 🤔 |
Ahh, ok. Well I propose that haha. WDYT? |
mmm yeah, for this module it would make sense given that it's a very short documentation (but would break consistency). For other modules, I don't think that would work, remember that we are rendering these files here: https://docs.cosmos.network/main/modules/capability/ Another option would be to have a script that collects all of the md files in a module's spec and puts them into a single file and we publish those somewhere else (titled: docs for real devs that will read this in a code editor and not in their browsers lol). |
Description
Add and fix documentation for x/capability module
Closes: #11793
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...
!
to the type prefix if API or client breaking changeCHANGELOG.md
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...
!
in the type prefix if API or client breaking change