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/data): update module overview #915

Merged
merged 4 commits into from
Mar 21, 2022
Merged

Conversation

ryanchristo
Copy link
Member

@ryanchristo ryanchristo commented Mar 20, 2022

Description

Ref: #889

Update data overview and protobuf links.


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...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the documentation writing guidelines
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

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...

  • confirmed the correct docs: prefix in the PR title
  • confirmed all author checklist items have been addressed
  • confirmed that this PR only changes documentation
  • reviewed content for consistency
  • reviewed content for thoroughness
  • reviewed content for spelling and grammar
  • tested instructions (if applicable)

@codecov
Copy link

codecov bot commented Mar 20, 2022

Codecov Report

Merging #915 (b585089) into master (3535b13) will increase coverage by 6.79%.
The diff coverage is n/a.

❗ Current head b585089 differs from pull request most recent head 509808a. Consider uploading reports for the commit 509808a to get more accurate results

@@            Coverage Diff             @@
##           master     #915      +/-   ##
==========================================
+ Coverage   65.65%   72.45%   +6.79%     
==========================================
  Files         178      183       +5     
  Lines       20216    22709    +2493     
==========================================
+ Hits        13273    16454    +3181     
+ Misses       5813     5038     -775     
- Partials     1130     1217      +87     
Flag Coverage Δ
experimental-codecov 72.45% <ø> (?)
stable-codecov ?

Flags with carried forward coverage won't be shown. Click here to find out more.

The `data` module emits events defined in [the Protobuf reference](./protobuf.html#regen-data-v1alpha2-events-proto).
The data module emits events defined in the Protobuf definitions:

- [regen.data.v1](https://buf.build/regen/regen-ledger/docs/main/regen.data.v1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [regen.data.v1](https://buf.build/regen/regen-ledger/docs/main/regen.data.v1)
- [regen.data.v1](https://buf.build/regen/regen-ledger/docs/main/regen.data.v1#regen.data.v1.EventAnchorData)

should we link to the first event in the page?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmmm... I was wondering the same thing since there is no event header but the event might change or a new event might be added before it. Maybe not likely but I think it's ok to leave as is for now.

@ryanchristo ryanchristo enabled auto-merge (squash) March 21, 2022 23:35
@ryanchristo ryanchristo merged commit 1a063a3 into master Mar 21, 2022
@ryanchristo ryanchristo deleted the ryan/889-data-overview branch March 21, 2022 23:37
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.

3 participants