docs(l1): latest valid ancestor store methods #2669
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The
Store
methodsset_latest_valid_ancestor
&get_latest_valid_ancestor
can be confusing without proper documentation. These methods were properly documented on theStoreEngine
trait, but they were not documented in theStore
structure where they will be most often called from. This PR adds documentation for these methods on theStore
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
Store
methodsset_latest_valid_ancestor
&get_latest_valid_ancestor
Closes None