Skip to content
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.

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

Small Release/README Fixes #949

Merged
merged 3 commits into from
Nov 14, 2020
Merged

Small Release/README Fixes #949

merged 3 commits into from
Nov 14, 2020

Conversation

holgerd77
Copy link
Member

This PR fixes some inconsistencies within the README files discovered while browsing through the repository after having done the beta.2 releases.

Changes are mostly header updates and headline hierarchy corrections, also some small rewrites.

The eventually somewhat unusual (or: not so commonly spotted) subtitle formatting is a table header without a body and renders like the following:

Bildschirmfoto 2020-11-12 um 10 55 51

@codecov
Copy link

codecov bot commented Nov 12, 2020

Codecov Report

Merging #949 (9dcbca7) into master (e8c5c54) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

Flag Coverage Δ
block 75.36% <ø> (ø)
blockchain 77.39% <ø> (ø)
common 91.87% <ø> (-0.25%) ⬇️
ethash 82.08% <ø> (ø)
tx 86.25% <ø> (ø)
vm 87.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

evertonfraga
evertonfraga previously approved these changes Nov 12, 2020
Copy link
Contributor

@evertonfraga evertonfraga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for the added consistency.

I made two code suggestions that are not blockers, so I am approving the changes here.


[![NPM Package][block-npm-badge]][block-npm-link]
[![GitHub Issues][block-issues-badge]][block-issues-link]
[![Actions Status][block-actions-badge]][block-actions-link]
[![Code Coverage][block-coverage-badge]][block-coverage-link]
[![Discord][discord-badge]][discord-link]

Implements schema and functions related to Ethereum's block.
| Implements schema and functions related to Ethereum's block. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice result! :)

packages/vm/README.md Outdated Show resolved Hide resolved
packages/ethash/README.md Outdated Show resolved Hide resolved
packages/common/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ryanio ryanio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@ryanio
Copy link
Contributor

ryanio commented Nov 14, 2020

The new GitHub feature to batch suggestions into one commit is very cool!

@ryanio ryanio merged commit 222283b into master Nov 14, 2020
@ryanio ryanio deleted the small-release-fixes branch November 14, 2020 18:54
@holgerd77
Copy link
Member Author

@ryanio oh yeah, that's indeed super-cool, otherwise having 10 commits for correcting 10 typos is purely insane. 😜 Thanks for integrating this and merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants