bitswap/README.md: Cleaning up the format #168

dgrisham · 2017-11-15T19:44:54Z

Going to start updating this document soon, so I figured I'd handle the reformatting before I made any content changes to keep commits/updates clean.

dgrisham · 2017-11-15T19:46:53Z

@diasdavid

daviddias · 2017-11-16T12:41:49Z

bitswap/README.md

-Bitswap is the data trading module for ipfs, it manages requesting and sending blocks to and from other peers in the network. Bitswap has two main jobs, the first is to acquire blocks requested by the client from the network. The second is to judiciously send blocks in its posession to other peers who want them.
-
+Bitswap is the data trading module for ipfs, it manages requesting and sending
+blocks to and from other peers in the network. Bitswap has two main jobs, the


Keeping it one line is fine :)

Gotcha, I'll change that back. Kind of unfortunately painful to deal with for my text editor, but I'll get by :)

@dgrisham which editor are you using?

Kakoune -- it has visual soft-wrapping, but unfortunately it still behaves like a single line when you use that feature. It's a young text editor, so these things come with the territory. I just made a Bash function that uses pandoc to convert the input file to one with 80-character lines, then once I exit the text editor it converts it back so that the paragraphs are all on one line again (as it is here).

daviddias

The rest LGTM

daviddias · 2017-11-21T15:49:41Z

bitswap/README.md

+      }
+
+      optional Wantlist wantlist = 1;
+      repeated bytes blocks = 2;
    }


Why remove the ```?

daviddias · 2017-11-21T15:50:06Z

bitswap/README.md

 # Implementation details

-Also, make sure to read - https://github.com/ipfs/go-ipfs/tree/master/exchange/bitswap#go-ipfs-implementation
+Also, make sure to read - <https://github.com/ipfs/go-ipfs/tree/master/exchange/bitswap#go-ipfs-implementation>


No need for angle brackets

daviddias · 2017-11-21T15:50:40Z

bitswap/README.md

-  // 2) if not -> ask bitswap
-    // 2.1) bitswap will cb() once the block is back, once. bitswap will write to the repo as well. 
-})
-```


You should not remove the ```, they make the code rendered with sintax highlighting

dgrisham · 2017-11-21T20:42:26Z

@diasdavid ACK on those comments -- when I used pandoc to handle the line length thing, it also reformatted other parts of the document. I should've caught that, I'll rework my solution and push once it's not doing those unnecessary rewrites.

dgrisham · 2017-12-12T21:48:25Z

@diasdavid Hey, finally got back to this, let me know what you think.

daviddias · 2017-12-13T07:26:44Z

bitswap/README.md

-
-# Status of this spec
+Status of this spec
+===================


Why switch from # to ====?

daviddias · 2017-12-13T07:27:06Z

bitswap/README.md

- c) Send it. 
+1.  Ensure it has a connection to its peer
+2.  Grab the message to be sent
+3.  Send it


This will not auto enum in Github flavoured markdown

Are you sure? Seems to indicate that it will on the spec here, at least if I'm understanding it correctly.

You are right! :)

daviddias · 2017-12-13T07:27:33Z

bitswap/README.md

+-   bitswap-decision-engine
+-   bitswap-message
+-   bitswap-net
+-   bitswap-wantlist


Too many spaces

daviddias · 2017-12-13T07:27:40Z

bitswap/README.md

+-   bitswap.peerConnected(peer)
+    -   add peer to peer set + send them wantlist (maybe)
+-   bitswap.peerDisconnected(peer)
+    -   remove peer from peer set


Too many spaces

dgrisham · 2017-12-13T15:51:28Z

@diasdavid Updated again -- the brackets around links are there again, because pandoc uses Github's CommonMark writer and they have that as part of their specification.

Edit: To be more clear about that: everything in this version of the document is exactly what Github's CommonMark writer outputs, except for the codeblocks that you pointed out before -- I edited pandoc a bit to put the ``` around codeblocks rather than indenting, I agree that that's better here.

daviddias

Thanks ! :)

dgrisham · 2017-12-13T16:54:08Z

@diasdavid Thanks David! Would you mind merging? I don't have permissions to do so.

daviddias reviewed Nov 16, 2017

View reviewed changes

daviddias approved these changes Nov 16, 2017

View reviewed changes

dgrisham force-pushed the fmt/reformatting branch from 21cb5ca to 580e1c3 Compare November 20, 2017 23:18

daviddias requested changes Nov 21, 2017

View reviewed changes

dgrisham force-pushed the fmt/reformatting branch 4 times, most recently from 0f19c3e to 6a952da Compare December 12, 2017 21:47

dgrisham force-pushed the fmt/reformatting branch from 6a952da to ee54085 Compare December 13, 2017 03:34

dgrisham mentioned this pull request Dec 13, 2017

Bitswap spec update #171

Merged

daviddias requested changes Dec 13, 2017

View reviewed changes

bitswap/README.md: Cleaning up the format

327deb5

dgrisham force-pushed the fmt/reformatting branch from ee54085 to 327deb5 Compare December 13, 2017 15:47

daviddias approved these changes Dec 13, 2017

View reviewed changes

daviddias merged commit 342b373 into ipfs:master Dec 13, 2017

dgrisham deleted the fmt/reformatting branch December 13, 2017 18:06

bitswap/README.md: Cleaning up the format #168

bitswap/README.md: Cleaning up the format #168

Uh oh!

Conversation

dgrisham commented Nov 15, 2017

Uh oh!

dgrisham commented Nov 15, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daviddias left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgrisham commented Nov 21, 2017

Uh oh!

dgrisham commented Dec 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgrisham commented Dec 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daviddias left a comment

Choose a reason for hiding this comment

Uh oh!

dgrisham commented Dec 13, 2017

Uh oh!

Uh oh!

dgrisham commented Dec 13, 2017 •

edited

Loading