Skip to content
This repository has been archived by the owner on Dec 1, 2022. It is now read-only.

Harmonize notation and documentation #13

Open
asonnino opened this issue Jul 14, 2021 · 0 comments
Open

Harmonize notation and documentation #13

asonnino opened this issue Jul 14, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@asonnino
Copy link
Contributor

asonnino commented Jul 14, 2021 •
edited
Loading

  • Document public structs and fields, so that cargo doc produces something nice.
  • Harmonize variable names (eg. voting_rights)
  • Rename Parameters into something like Node, NodeConfig, or NodeSpawner and/or incorporating more of the parameters of spawn(..)
  • Remove the node crate and include the main functions into the respective crates (eg. librabft-v2)
@asonnino asonnino added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@asonnino