ethereum / ethereum/execution-specs

chore(doc): ensure all doc-strings are in markdown

Open
#671 6 comments 0 reactions 1 assignee Claimed by @gurukamath View on GitHub
A-doc C-feat E-easy P-medium stale
Dominant language
Python
Stars
1.2k
Forks
505
Avg merge
2d 8h
Merged PRs (30d)
106

Description

I see that the other docstrings use the former syntax. If we have to change the syntax, I guess it will be a good idea to create a new issue and change the syntax for all the docstrings.

_Originally posted by @gurukamath in https://github.com/ethereum/execution-specs/pull/627#discussion_r1051381885_

The criteria mentioned [here](https://github.com/ethereum/execution-specs/pull/1428#issuecomment-3323253209) should also be kept in mind while re-writing the doc-strings.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.