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

fix docs format #2492

Merged
merged 5 commits into from
Aug 11, 2024
Merged

fix docs format #2492

merged 5 commits into from
Aug 11, 2024

Conversation

yihau
Copy link
Member

@yihau yihau commented Aug 8, 2024

(part of #2487)

Problem

Screenshot 2024-08-08 at 21 49 51

docs take a stricter approach to indentation rules…

Summary of Changes

fix it

@yihau yihau marked this pull request as ready for review August 8, 2024 16:35
@yihau yihau requested a review from brooksprumo August 8, 2024 16:35
accounts-db/src/account_storage.rs Outdated Show resolved Hide resolved
accounts-db/src/ancient_append_vecs.rs Outdated Show resolved Hide resolved
@yihau
Copy link
Member Author

yihau commented Aug 9, 2024

thank you! just committed those 2 changes 🫡

Comment on lines 47 to 48
/// Operations like shrinking or write cache flushing may have updated the index between when the caller read the index and called this function to
/// load from the append vec specified in the index.

Choose a reason for hiding this comment

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

I think the extra leading spaces can be removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

thank you for catching this one! fixed: 1b6f399

@@ -2,7 +2,8 @@
//! an ancient append vec is:
//! 1. a slot that is older than an epoch old
//! 2. multiple 'slots' squashed into a single older (ie. ancient) slot for convenience and performance
//! Otherwise, an ancient append vec is the same as any other append vec
//!
//! Otherwise, an ancient append vec is the same as any other append vec

Choose a reason for hiding this comment

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

Same here.

Copy link
Member Author

Choose a reason for hiding this comment

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

same here! 828cad4 thank you very much! I almost commit a weird docs format into master 🙈

Copy link

@brooksprumo brooksprumo left a comment

Choose a reason for hiding this comment

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

:shipit:

@yihau yihau merged commit 5980c08 into anza-xyz:master Aug 11, 2024
40 checks passed
@yihau yihau deleted the fix-docs-1 branch August 11, 2024 09:15
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.

2 participants