Commit e920898
authored
feat(docs): latest valid ancestor store methods (#2669)
**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.
<!-- Why does this pull request exist? What are its goals? -->
**Description**
* Add doc comments for `Store` methods `set_latest_valid_ancestor` &
`get_latest_valid_ancestor`
<!-- A clear and concise general description of the changes this PR
introduces -->
<!-- Link to issues: Resolves #111, Resolves #222 -->
Closes None1 parent a44f435 commit e920898
1 file changed
+3
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1074 | 1074 | | |
1075 | 1075 | | |
1076 | 1076 | | |
| 1077 | + | |
| 1078 | + | |
1077 | 1079 | | |
1078 | 1080 | | |
1079 | 1081 | | |
1080 | 1082 | | |
1081 | 1083 | | |
1082 | 1084 | | |
1083 | 1085 | | |
| 1086 | + | |
1084 | 1087 | | |
1085 | 1088 | | |
1086 | 1089 | | |
| |||
0 commit comments