Fix light client docs to match function signature

In the light client docs a mentioning of a function trigger is lacking
the `genesis_validators_root` argument. This patch adds that argument
to the documentation to match the real function signature. It also
slightly improves the grammar.
This commit is contained in:
Etan Kissling 2022-01-11 11:48:22 +01:00
parent fab4cb09b7
commit 79c456b9f4
No known key found for this signature in database
GPG Key ID: B21DA824C5A3D03D

View File

@ -127,7 +127,7 @@ def get_safety_threshold(store: LightClientStore) -> uint64:
## Light client state updates
A light client maintains its state in a `store` object of type `LightClientStore` and receives `update` objects of type `LightClientUpdate`. Every `update` triggers `process_light_client_update(store, update, current_slot)` where `current_slot` is the current slot based on some local clock. `process_slot_for_light_client_store` is processed every time the current slot increments.
A light client maintains its state in a `store` object of type `LightClientStore` and receives `update` objects of type `LightClientUpdate`. Every `update` triggers `process_light_client_update(store, update, current_slot, genesis_validators_root)` where `current_slot` is the current slot based on a local clock. `process_slot_for_light_client_store` is triggered every time the current slot increments.
#### `process_slot_for_light_client_store`