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

phase 0 doc standardization b4 spec freeze #1212

Merged
merged 8 commits into from
Jun 25, 2019
Merged

Conversation

JSON
Copy link
Contributor

@JSON JSON commented Jun 24, 2019

Following up on #1039 for documents pertaining to Phase 0, in particular.

Summary:

Dead links, stay-on-the-same-spec links, capitalization for the first word after "Note:" & when referring to a specific phase, abbreviations spelled out when the full version is used more often in the spec and the abbreviated version appears rarely, grammatical commas, standardized syntax for describing where 'Helper functions' on 0_beacon-chain.md are defined, British spelling 'utilised' --> "utilized", etc.

@JustinDrake
Copy link
Collaborator

Thanks for this :)

(As a side note, the freeze is only for substantive changes. Cosmetics things such as these are definitely welcome during and after the freeze.)

@djrtwo
Copy link
Contributor

djrtwo commented Jun 24, 2019

  • I count var names as substantive 😬 (unless realllllly good reason)

Copy link
Contributor

@djrtwo djrtwo left a comment

Choose a reason for hiding this comment

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

this is awesome :)

@JSON
Copy link
Contributor Author

JSON commented Jun 25, 2019

  • I count var names as substantive 😬 (unless realllllly good reason)

@djrtwo if i'm understanding correctly, i don't think i touched any var names

@djrtwo
Copy link
Contributor

djrtwo commented Jun 25, 2019

@JSON You didn't! That was a comment for @JustinDrake ...

@JustinDrake JustinDrake merged commit 20602bc into ethereum:dev Jun 25, 2019
@JSON JSON deleted the patch-1 branch June 25, 2019 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants