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.

Sign up for GitHub

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

Jump to bottom

Proto message documentation #1826

Closed
7 of 9 tasks
ValarDragon opened this issue Jun 20, 2022 · 2 comments
Closed
7 of 9 tasks

Proto message documentation #1826

ValarDragon opened this issue Jun 20, 2022 · 2 comments
Labels
C:docs Improvements or additions to documentation T:tracking issue ⛰

Comments

@ValarDragon
Copy link
Member

ValarDragon commented Jun 20, 2022 •
edited by p0mvn
Loading

Background

Tracking issue for our milestone of significantly improving the documentation for each protobuf message and state entry.

Every field in every proto message should have documentation explaining what its for, and what values constitute valid input.
These can then get translated in every languages protobuf compilation, and help improve understandability.

Modules
@ValarDragon ValarDragon added C:docs Improvements or additions to documentation T:tracking issue ⛰ labels Jun 20, 2022
@daniel-farina daniel-farina moved this to Needs Review 🔍 in Osmosis Chain Development Jun 20, 2022
@p0mvn
Copy link
Member

p0mvn commented Jul 15, 2022

Based on my review only gamm and pool-incentives are still missing documentation for some messages and fields. Going to create a separate issue for each and close this one

@p0mvn p0mvn closed this as completed Jul 15, 2022
Repository owner moved this from Needs Review 🔍 to Done ✅ in Osmosis Chain Development Jul 15, 2022
@p0mvn
Copy link
Member

p0mvn commented Jul 15, 2022

Remaining items:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C:docs Improvements or additions to documentation T:tracking issue ⛰
Projects
Osmosis Chain Development
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ValarDragon @p0mvn