Skip to content

docs(l1): latest valid ancestor store methods #2669

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

Merged
merged 1 commit into from
May 6, 2025

Conversation

fmoletta
Copy link
Contributor

@fmoletta fmoletta commented May 5, 2025

Motivation
The Store methods set_latest_valid_ancestor & get_latest_valid_ancestor can be confusing without proper documentation. These methods were properly documented on the StoreEngine trait, but they were not documented in the Store structure where they will be most often called from. This PR adds documentation for these methods on the Store implementation while also simplifying it, as the internal trait documentation provides more information on the context and design choices/requirements for the implementation which are not necessary for the top-level methods.

Description

  • Add doc comments for Store methods set_latest_valid_ancestor & get_latest_valid_ancestor

Closes None

@fmoletta fmoletta marked this pull request as ready for review May 5, 2025 20:17
@fmoletta fmoletta requested a review from a team as a code owner May 5, 2025 20:17
@fmoletta fmoletta changed the title feat(docs): latest valid ancestor store methods feat(doc): latest valid ancestor store methods May 5, 2025
@fmoletta fmoletta changed the title feat(doc): latest valid ancestor store methods feat(docs): latest valid ancestor store methods May 6, 2025
@fmoletta fmoletta added this pull request to the merge queue May 6, 2025
@fmoletta fmoletta changed the title feat(docs): latest valid ancestor store methods docs(l1): latest valid ancestor store methods May 6, 2025
Merged via the queue into main with commit e920898 May 6, 2025
22 of 25 checks passed
@fmoletta fmoletta deleted the doc-latest-valid-ancestors-store-methods branch May 6, 2025 13:56
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