Merge pull request #2234 from ethereum/ssz-snappy-proofread

[minor] Fix some leftover from #2097 (ssz-snappy)

tests/core/pyspec/eth2spec/gen_helpers/README.md

@@ -43,8 +43,8 @@ The yielding pattern is:
 3 value style: `yield <key name> <kind name> <value>`.
 
 Test part output kinds:
-- `ssz`: value is expected to be a `bytes`, and the raw data is written to a `<key name>.ssz` file.
+- `ssz`: value is expected to be a `bytes`, and the raw data is written to a `<key name>.ssz_snappy` file.
-- `data`: value is expected to be any python object that can be dumped as YAML. Output is written to `<key name>.yaml`
+- `data`: value is expected to be any Python object that can be dumped as YAML. Output is written to `<key name>.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.
 

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
 

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_<index>.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

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`.
 

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

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`

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.
 
 ### `<input-name>.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

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
 

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_<index>.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

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`.