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

Document schema better #1118

Closed
kderme opened this issue May 13, 2022 · 2 comments
Closed

Document schema better #1118

kderme opened this issue May 13, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@kderme
Copy link
Contributor

kderme commented May 13, 2022

Schema docs are quite important to downstream componets. We should fix existing documentation, extend it, add warnings or even add links where content values are further explained. We could also add the version where each new field/table has been added and its previous name if it's renamed.

A small list of ideas

  • epoch_reward_total_received needs fixing, since its content have changed.
  • epoch_stake should mention that it affect the elections for the specified epoch and that it may be inserted delayed.
@kderme kderme added the documentation Improvements or additions to documentation label May 13, 2022
@erikd
Copy link
Contributor

erikd commented May 13, 2022

i think that epoch_reward_received table needs to be dropped. It was added when I was trying to fix rewards.

@kderme kderme mentioned this issue May 24, 2022
7 tasks
@kderme
Copy link
Contributor Author

kderme commented Jun 29, 2022

I believe this has been sufficiently improved.

@kderme kderme closed this as completed Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants