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

[docs] improve organization of ABCI docs & fix links #2749

Merged
merged 8 commits into from Nov 9, 2018
Merged

[docs] improve organization of ABCI docs & fix links #2749

merged 8 commits into from Nov 9, 2018

Conversation

zramsay
Copy link
Contributor

@zramsay zramsay commented Nov 2, 2018

starts #2379, see linked PRs in my fork for the separate pieces

  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Updated CHANGELOG_PENDING.md

Copy link
Contributor

@melekes melekes left a comment

Choose a reason for hiding this comment

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

🍓 🍌 🥛

@codecov-io
Copy link

codecov-io commented Nov 2, 2018

Codecov Report

Merging #2749 into develop will decrease coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #2749      +/-   ##
==========================================
- Coverage    62.42%   62.3%   -0.12%     
==========================================
  Files          212     212              
  Lines        17185   17143      -42     
==========================================
- Hits         10727   10681      -46     
- Misses        5565    5567       +2     
- Partials       893     895       +2
Impacted Files Coverage Δ
libs/events/events.go 93.2% <0%> (-4.86%) ⬇️
libs/db/remotedb/remotedb.go 36.84% <0%> (-4.69%) ⬇️
consensus/reactor.go 67.71% <0%> (-1.87%) ⬇️
libs/clist/clist.go 66.66% <0%> (-1.52%) ⬇️
consensus/state.go 79.78% <0%> (-0.71%) ⬇️
blockchain/pool.go 66.43% <0%> (+0.69%) ⬆️
privval/ipc_server.go 69.81% <0%> (+5.66%) ⬆️

@@ -0,0 +1,35 @@
# ABCI Implementations
Copy link
Contributor

Choose a reason for hiding this comment

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

This is great but seems its still largely a duplicate of https://github.com/tendermint/tendermint/blob/develop/docs/spec/abci/client-server.md

Can we just make sure that file contains anything from here it might be missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

appropriately (ie. to `socket` or `grpc`).

Note that the GRPC version is maintained primarily to simplify onboarding and prototyping and is not receiving the same
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure the spec is the right place for such things.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

@melekes melekes merged commit 8b77328 into tendermint:develop Nov 9, 2018
@zramsay zramsay deleted the zach/docs-abci branch November 9, 2018 14:12
maxim-levy pushed a commit to maxim-levy/tendermint that referenced this pull request Nov 13, 2018
* 'master' of https://github.com/tendermint/tendermint: (330 commits)
  Release/v0.26.1 (tendermint#2803)
  fix amino overhead computation for Tx (tendermint#2792)
  p2p: re-check after sleeps (tendermint#2664)
  check the result of `ps.peer.Send` before calling `ps.setHasVote` (tendermint#2787)
  p2p: AddressBook requires addresses to have IDs; Do not close conn immediately after sending pex addrs in seed mode (tendermint#2797)
  test AutoFile#Size (happy path)
  [autofile/group] do not panic when checking size
  openFile creates a file if not exist => ErrNotExist is not possible
  use our logger in autofile/group
  Add tests for ValidateBasic methods (tendermint#2754)
  [docs] improve organization of ABCI docs & fix links (tendermint#2749)
  p2p: peer-id -> peer_id (tendermint#2771)
  mempool: print postCheck error (tendermint#2762)
  Fix crypto/merkle ProofOperators.Verify to check bounds on keypath pa… (tendermint#2756)
  Mempool WAL is still created by default in home directory, leads to permission errors (tendermint#2758)
  mempool: ErrPreCheck and more log info (tendermint#2724)
  Release/v0.26.0 (tendermint#2726)
  [ADR] [DRAFT] pubsub 2.0 (tendermint#2532)
  validate reactor messages (tendermint#2711)
  TMHASH is 32 bytes. Closes tendermint#1990 (tendermint#2732)
  ...
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.

None yet

4 participants