-
Notifications
You must be signed in to change notification settings - Fork 586
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: style/formatting improvements for using ibc-go > overview #5808
docs: style/formatting improvements for using ibc-go > overview #5808
Conversation
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.
Nice improvements @crodriguezvega! 🚀
Co-authored-by: Damian Nolan <damiannolan@gmail.com>
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.
seems like an sisyphian uphill battle 😅, maybe we should at least link the google style guide in the contributing guidelines someplace?
Sisyphos was a sissy compared to me, man. 😜 |
HAHA, absolutely destroyed. |
Description
This is the first of (probably) many PRs I will try to open to unify a bit the style of our docs following the recommendations of Google's developer documentation style guide. Jeez, I wish there was a linter for this...
closes: #XXXX
Commit Message / Changelog Entry
see the guidelines for commit messages. (view raw markdown for examples).
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
).godoc
comments.Files changed
in the Github PR explorer.Codecov Report
in the comment section below once CI passes.