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: add list of all stages #2826

Merged
merged 1 commit into from
May 25, 2023
Merged

docs: add list of all stages #2826

merged 1 commit into from
May 25, 2023

Conversation

mattsse
Copy link
Collaborator

@mattsse mattsse commented May 25, 2023

Closes #2254

I keep forgetting the order of stages.

🤖 Generated by Copilot at 1437bb7

This pull request adds documentation comments to the Stages trait and the DefaultStages struct in the stages crate. These comments clarify the role and functionality of the pipeline stages that reth uses to sync with the Ethereum network.

@mattsse mattsse added the C-docs An addition or correction to our documentation label May 25, 2023
Comment on lines +74 to +76
/// - [`IndexStorageHistoryStage`]
/// - [`IndexAccountHistoryStage`]
Copy link
Member

Choose a reason for hiding this comment

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

you missed TransactionLookup & Finish stages

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added

@codecov-commenter
Copy link

codecov-commenter commented May 25, 2023

Codecov Report

Merging #2826 (539f779) into main (dfcca69) will increase coverage by 0.02%.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##             main    #2826      +/-   ##
==========================================
+ Coverage   71.39%   71.41%   +0.02%     
==========================================
  Files         505      505              
  Lines       66142    66142              
==========================================
+ Hits        47219    47238      +19     
+ Misses      18923    18904      -19     
Flag Coverage Δ
integration-tests 17.35% <ø> (-0.02%) ⬇️
unit-tests 66.37% <ø> (+0.03%) ⬆️

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

Impacted Files Coverage Δ
crates/stages/src/pipeline/mod.rs 88.93% <ø> (ø)
crates/stages/src/sets.rs 0.00% <ø> (ø)

... and 4 files with indirect coverage changes

@onbjerg onbjerg merged commit f00dc09 into main May 25, 2023
@onbjerg onbjerg deleted the matt/add-list-of-stages branch May 25, 2023 13:47
shekhirin pushed a commit that referenced this pull request May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a list with the order of all stages to staged sync and/or pipeline docs
4 participants