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.

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

Jump to bottom

(non-substantive) p2p formating #1953

Merged
merged 2 commits into from
Jul 3, 2020
Merged

(non-substantive) p2p formating #1953

merged 2 commits into from
Jul 3, 2020

Conversation

djrtwo
Copy link
Contributor

@djrtwo djrtwo commented Jul 3, 2020 •
edited
Loading

  • break gossipsub topics into their own markdown headers (to enhance linkability from external sources, e.g. eth2.0-apis -- CC @mpetrunic)
  • also pulling the band-aid off and adding better line breaks throughout the doc for better future diffs

@djrtwo djrtwo changed the title [WIP] (non-substantive) p2p format updates (non-substantive) split up p2p topics into markdown subsections Jul 3, 2020
@djrtwo djrtwo requested a review from protolambda July 3, 2020 13:55
@djrtwo djrtwo changed the title (non-substantive) split up p2p topics into markdown subsections (non-substantive) p2p formating Jul 3, 2020
protolambda
protolambda approved these changes Jul 3, 2020
View reviewed changes
Copy link
Contributor

@protolambda protolambda left a comment

Choose a reason for hiding this comment

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

Went through the mega-diff with github rich-diff (cosmetic markdown changes show as no-op) and Intellij (no content missing or changed)
The TLDR of changes:

  • Many simple clarifications of types / topic names
  • Forward reference to different topic names
  • Headers
  • Lots of newlines
  • - -> -- in FAQ text mostly

Looks good, future diffs will now be contained better to just the bits that actually change, instead of the previous 300-600 character long lines.

@protolambda protolambda merged commit a019b03 into dev Jul 3, 2020
@protolambda protolambda deleted the p2p-format branch July 3, 2020 15:44
@terencechain terencechain mentioned this pull request Jul 24, 2020
Closed
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@protolambda protolambda protolambda approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@djrtwo @protolambda