Skip to content

chore(spec): rst -> md for MPT #2814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SamWilsn wants to merge 1 commit into
base: forks/amsterdam
Choose a base branch
from
Open

chore(spec): rst -> md for MPT #2814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .claude/commands/write-docstring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Conventions for writing docstrings in `src/ethereum/`. Docstrings are the primar
- Do not include constants/numeric values in the docstring (values in docstrings can easily desync with the code, and no tool will detect it)
- Avoid restating what the code is doing (the code should speak for itself)
- Avoid mentioning the current fork unnecessarily (creates noisy diffs between forks)
- Docstrings should be reserved for meaningful specification, while comments (`# ...`) can be used to explain particulars of the Python reference implementation

## Module Docstrings

Expand Down Expand Up @@ -247,6 +248,8 @@ Bare URLs in angle brackets for inline use:
Available at <https://github.com/ethereum/genesis_block_generator>.
```

If a URL is too long to include because of the line length limit, you can add `# noqa: E501` after the trailing `"""` to squelch the warning (but this should be a last resort).

### Usage in text

Reference links are used inline with brackets:
Expand Down
Loading
Loading