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

Deprecate/refactor content in docs/specification #1934

Merged
merged 4 commits into from
Jul 11, 2018

Conversation

zramsay
Copy link
Contributor

@zramsay zramsay commented Jul 9, 2018

closes #1814
replaces #1914

  • [it is docs] Updated all relevant documentation in docs
  • [no code] Updated all code comments where relevant
  • Wrote tests
  • Updated CHANGELOG.md

@zramsay zramsay requested a review from jbibla as a code owner July 9, 2018 22:53
@zramsay zramsay changed the title Zach/fix specification Deprecate/refactor content in docs/specification Jul 9, 2018
@codecov-io
Copy link

Codecov Report

Merging #1934 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1934   +/-   ##
========================================
  Coverage    60.72%   60.72%           
========================================
  Files          217      217           
  Lines        16976    16976           
========================================
  Hits         10308    10308           
- Misses        5778     5779    +1     
+ Partials       890      889    -1
Impacted Files Coverage Δ
p2p/pex/pex_reactor.go 72.07% <0%> (-0.33%) ⬇️
p2p/conn/connection.go 82.25% <0%> (+0.28%) ⬆️

5. After editing, convert this file back into binary form by running:

```
./scripts/json2wal/json2wal /tmp/corrupted_wal > "$TMHOME/data/cs.wal/wal"
Copy link
Contributor

Choose a reason for hiding this comment

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

this tool was removed. we need to find and bring it back

Copy link
Contributor

Choose a reason for hiding this comment

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

@melekes Can you create a follow-up issue?

Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -1,172 +0,0 @@
Wire Protocol
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't we at least provide a link to go-amino?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the docs landing page will need improvements after this PR, which will point people to various places

Copy link
Contributor

@xla xla left a comment

Choose a reason for hiding this comment

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

👍 :octocat: :shipit: 🍡

5. After editing, convert this file back into binary form by running:

```
./scripts/json2wal/json2wal /tmp/corrupted_wal > "$TMHOME/data/cs.wal/wal"
Copy link
Contributor

Choose a reason for hiding this comment

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

@melekes Can you create a follow-up issue?

@melekes melekes mentioned this pull request Jul 11, 2018
@melekes melekes merged commit bbf2bd1 into develop Jul 11, 2018
@melekes melekes deleted the zach/fix-specification branch July 11, 2018 19:45
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.

4 participants