From 1c0238075e12ef537a3cb4c0695b430b536d9d79 Mon Sep 17 00:00:00 2001 From: Hsiao-Wei Wang Date: Sat, 13 Mar 2021 12:42:51 +0800 Subject: [PATCH] Fix some leftover from #2097 --- tests/core/pyspec/eth2spec/gen_helpers/README.md | 4 ++-- tests/formats/epoch_processing/README.md | 4 ++-- tests/formats/finality/README.md | 4 ++-- tests/formats/forks/README.md | 4 ++-- tests/formats/genesis/initialization.md | 4 ++-- tests/formats/genesis/validity.md | 2 +- tests/formats/operations/README.md | 6 +++--- tests/formats/rewards/README.md | 12 ++++++------ tests/formats/sanity/blocks.md | 4 ++-- tests/formats/sanity/slots.md | 8 ++++---- 10 files changed, 26 insertions(+), 26 deletions(-) diff --git a/tests/core/pyspec/eth2spec/gen_helpers/README.md b/tests/core/pyspec/eth2spec/gen_helpers/README.md index d39ee66ae..5bd76b99f 100644 --- a/tests/core/pyspec/eth2spec/gen_helpers/README.md +++ b/tests/core/pyspec/eth2spec/gen_helpers/README.md @@ -43,8 +43,8 @@ The yielding pattern is: 3 value style: `yield `. Test part output kinds: -- `ssz`: value is expected to be a `bytes`, and the raw data is written to a `.ssz` file. -- `data`: value is expected to be any python object that can be dumped as YAML. Output is written to `.yaml` +- `ssz`: value is expected to be a `bytes`, and the raw data is written to a `.ssz_snappy` file. +- `data`: value is expected to be any Python object that can be dumped as YAML. Output is written to `.yaml` - `meta`: these key-value pairs are collected into a dict, and then collectively written to a metadata file named `meta.yaml`, if anything is yielded with `meta` empty. diff --git a/tests/formats/epoch_processing/README.md b/tests/formats/epoch_processing/README.md index 6469682dc..3ac2a28c4 100644 --- a/tests/formats/epoch_processing/README.md +++ b/tests/formats/epoch_processing/README.md @@ -17,11 +17,11 @@ bls_setting: int -- see general test-format spec. ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before running the epoch sub-transition. +An SSZ-snappy encoded `BeaconState`, the state before running the epoch sub-transition. ### `post.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state after applying the epoch sub-transition. +An SSZ-snappy encoded `BeaconState`, the state after applying the epoch sub-transition. ## Condition diff --git a/tests/formats/finality/README.md b/tests/formats/finality/README.md index 2d279b441..af39f5c8c 100644 --- a/tests/formats/finality/README.md +++ b/tests/formats/finality/README.md @@ -16,7 +16,7 @@ blocks_count: int -- the number of blocks processed in this test. ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before running the block transitions. +An SSZ-snappy encoded `BeaconState`, the state before running the block transitions. Also available as `pre.ssz_snappy`. @@ -32,7 +32,7 @@ Each block is also available as `blocks_.ssz_snappy` ### `post.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state after applying the block transitions. +An SSZ-snappy encoded `BeaconState`, the state after applying the block transitions. ## Condition diff --git a/tests/formats/forks/README.md b/tests/formats/forks/README.md index 2226a3f20..36ce942d7 100644 --- a/tests/formats/forks/README.md +++ b/tests/formats/forks/README.md @@ -26,11 +26,11 @@ Key of valid `fork` strings that might be found in `meta.yaml` ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before running the fork transition. +An SSZ-snappy encoded `BeaconState`, the state before running the fork transition. ### `post.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state after applying the fork transition. +An SSZ-snappy encoded `BeaconState`, the state after applying the fork transition. *Note*: This type is the `BeaconState` after the fork and is *not* the same type as `pre`. diff --git a/tests/formats/genesis/initialization.md b/tests/formats/genesis/initialization.md index 2e5452821..4b365c2ef 100644 --- a/tests/formats/genesis/initialization.md +++ b/tests/formats/genesis/initialization.md @@ -6,7 +6,7 @@ Tests the initialization of a genesis state based on Eth1 data. ### `eth1_block_hash.ssz_snappy` -A SSZ-snappy encoded root of the Eth1 block. +An SSZ-snappy encoded root of the Eth1 block. ### `eth1_timestamp.yaml` @@ -27,7 +27,7 @@ Each file is a SSZ-snappy encoded `Deposit` object. ### `state.ssz_snappy` -The expected genesis state. A SSZ-snappy encoded `BeaconState` object. +The expected genesis state. An SSZ-snappy encoded `BeaconState` object. ## Processing diff --git a/tests/formats/genesis/validity.md b/tests/formats/genesis/validity.md index 1b3f79879..f2e91222a 100644 --- a/tests/formats/genesis/validity.md +++ b/tests/formats/genesis/validity.md @@ -6,7 +6,7 @@ Tests if a genesis state is valid, i.e. if it counts as trigger to launch. ### `genesis.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state to validate as genesis candidate. +An SSZ-snappy encoded `BeaconState`, the state to validate as genesis candidate. ### `is_valid.yaml` diff --git a/tests/formats/operations/README.md b/tests/formats/operations/README.md index ca77ab966..51d92a017 100644 --- a/tests/formats/operations/README.md +++ b/tests/formats/operations/README.md @@ -14,15 +14,15 @@ bls_setting: int -- see general test-format spec. ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before applying the operation. +An SSZ-snappy encoded `BeaconState`, the state before applying the operation. ### `.ssz_snappy` -A SSZ-snappy encoded operation object, e.g. a `ProposerSlashing`, or `Deposit`. +An SSZ-snappy encoded operation object, e.g. a `ProposerSlashing`, or `Deposit`. ### `post.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state after applying the operation. No value if operation processing is aborted. +An SSZ-snappy encoded `BeaconState`, the state after applying the operation. No value if operation processing is aborted. ## Condition diff --git a/tests/formats/rewards/README.md b/tests/formats/rewards/README.md index aee23c3e9..a6682042f 100644 --- a/tests/formats/rewards/README.md +++ b/tests/formats/rewards/README.md @@ -25,27 +25,27 @@ _Note_: No signature verification happens within rewards sub-functions. These ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before running the rewards sub-function. +An SSZ-snappy encoded `BeaconState`, the state before running the rewards sub-function. ### `source_deltas.ssz_snappy` -A SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_source_deltas` function +An SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_source_deltas` function ### `target_deltas.ssz_snappy` -A SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_target_deltas` function +An SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_target_deltas` function ### `head_deltas.ssz_snappy` -A SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_head_deltas` function +An SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_head_deltas` function ### `inclusion_delay_deltas.ssz_snappy` -A SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_inclusion_delay_deltas` function +An SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_inclusion_delay_deltas` function ### `inactivity_penalty_deltas.ssz_snappy` -A SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_inactivity_penalty_deltas` function +An SSZ-snappy encoded `Deltas` representing the rewards and penalties returned by the rewards the `get_inactivity_penalty_deltas` function ## Condition diff --git a/tests/formats/sanity/blocks.md b/tests/formats/sanity/blocks.md index a8b38ccae..7ea646b9e 100644 --- a/tests/formats/sanity/blocks.md +++ b/tests/formats/sanity/blocks.md @@ -16,7 +16,7 @@ blocks_count: int -- the number of blocks processed in this test. ### `pre.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state before running the block transitions. +An SSZ-snappy encoded `BeaconState`, the state before running the block transitions. ### `blocks_.ssz_snappy` @@ -28,7 +28,7 @@ Each file is a SSZ-snappy encoded `SignedBeaconBlock`. ### `post.ssz_snappy` -A SSZ-snappy encoded `BeaconState`, the state after applying the block transitions. +An SSZ-snappy encoded `BeaconState`, the state after applying the block transitions. ## Condition diff --git a/tests/formats/sanity/slots.md b/tests/formats/sanity/slots.md index 72a24da51..f1b8a1321 100644 --- a/tests/formats/sanity/slots.md +++ b/tests/formats/sanity/slots.md @@ -12,9 +12,9 @@ bls_setting: int -- see general test-format spec. ``` -### `pre.yaml` +### `pre.ssz_snappy` -A YAML-encoded `BeaconState`, the state before running the transitions. +An SSZ-snappy `BeaconState`, the state before running the transitions. Also available as `pre.ssz_snappy`. @@ -23,9 +23,9 @@ Also available as `pre.ssz_snappy`. An integer. The amount of slots to process (i.e. the difference in slots between pre and post), always a positive number. -### `post.yaml` +### `post.ssz_snappy` -A YAML-encoded `BeaconState`, the state after applying the transitions. +An SSZ-snappy `BeaconState`, the state after applying the transitions. Also available as `post.ssz_snappy`.