mirror of
https://github.com/OffchainLabs/prysm.git
synced 2026-02-11 21:45:12 -05:00
fab687d96d
**What type of PR is this?** Documentation **What does this PR do? Why is it needed?** * Move the ethspecify config from `/specrefs/.ethspecify` to `/.ethspecify`. * This allows developers to use inline specrefs (eg spec functions in godoc comments). * To do this, simply add a spec tag and run `ethspecify` to populate it. * Clean up specref exceptions; organize by upgrade & put items in the correct section. * Update a few godoc comments to use the new inline specref feature. * Update check-specrefs GitHub action so that it enforces up-to-date godocs. * Standardize specref naming; requiring a `#fork` tag for everything. * Add new specrefs (which haven't been implemented yet) which were missing. **Acknowledgements** - [x] I have read [CONTRIBUTING.md](https://github.com/prysmaticlabs/prysm/blob/develop/CONTRIBUTING.md). - [x] I have included a uniquely named [changelog fragment file](https://github.com/prysmaticlabs/prysm/blob/develop/CONTRIBUTING.md#maintaining-changelogmd). - [x] I have added a description with sufficient context for reviewers to understand this PR. - [x] I have tested that my changes work as expected and I added a testing plan to the PR description (if applicable). --------- Co-authored-by: james-prysm <90280386+james-prysm@users.noreply.github.com>