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] x/crisis - general audit and cleanup #8269

Merged
merged 3 commits into from
Jan 11, 2021
Merged

Conversation

aleem1314
Copy link
Contributor

Description

ref: #7659


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.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@aleem1314 aleem1314 added the T:Docs Changes and features related to documentation. label Jan 7, 2021
@aleem1314 aleem1314 requested a review from anilcse January 7, 2021 05:36
@aleem1314 aleem1314 marked this pull request as ready for review January 8, 2021 08:03
x/crisis/spec/02_messages.md Outdated Show resolved Hide resolved
@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Jan 8, 2021
InvariantRoute string
}
```
+++ https://github.com/cosmos/cosmos-sdk/blob/v0.40.0-rc7/proto/cosmos/crisis/v1beta1/tx.proto#L14-L22
Copy link
Contributor

Choose a reason for hiding this comment

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

Wouldn't it be nice for the messages doc to have the generated msg types, also is there a reason to prefer links over using proto messages directly

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI such links should just render as code samples on https://docs.cosmos.network/

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree it's slightly harder to read the raw md file, but I also believe it's less error-prone and easier to maintain.

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah I see where you're coming from, was just concerned about the readability when using github directly.

@mergify mergify bot merged commit a64bd8c into master Jan 11, 2021
@mergify mergify bot deleted the aleem/7659-crisis-docs branch January 11, 2021 12:51
aleem1314 added a commit that referenced this pull request Jan 12, 2021
* update docs

* review changes

Co-authored-by: atheeshp <[email protected]>
aleem1314 added a commit that referenced this pull request Jan 28, 2021
* update docs

* review changes

Co-authored-by: atheeshp <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants