Add package comments to packages that are missing them #1185
+76
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'm not quite sure which file in this package is the most prominent, but command.go seemed like a reasonable choice.
Discussion in [1]. [1]: ipfs#1158
Based on [1]. [1]: ipfs#1158
So folks looking in core can figure out how it fits into the repository as a whole.
I'm not entirely clear on the role that this package is filling, but this description seems like a reasonable guess based on a quick skim through it's exported API.
Currently garbage collection is triggered manually and there are no age-restrictions on the removal. I expect we'll eventually follow Git and auto-launch garbage collection when we hit some threshold of disk consumption (gc.auto). I expect we'll also follow Git and keep unpinned or unreachable objects (gc.pruneexpire, etc.). But we don't seem to do either of those yet.
|
👏 fighting the good fight! |
| shell/...: | ||
| The high-level API that gives consumers easy access to common | ||
| operations (e.g. create a file node from a reader without wrapping | ||
| with metadata). We work really hard to keep this stable. |
There was a problem hiding this comment.
👍 👏
Maybe also include:
/*
routing/...:
Routing system interface and implementations.
For example, the IPFS DHT lives here.
exchange/...:
Exchange system interface and implementations
For example, Bitswap lives here.
*/
|
👍 LGTM |
jbenet
added a commit
that referenced
this pull request
May 2, 2015
Add package comments to packages that are missing them
|
On Sat, May 02, 2015 at 12:22:18PM -0700, Juan Batiz-Benet wrote:
I guess I'll submit the next round of godocs as a follow-up PR ;). |
|
Yeah, keeps the ball rolling. always nice to merge things :) 👍 |
wking
added a commit
to wking/go-ipfs
that referenced
this pull request
May 4, 2015
On Sat, May 02, 2015 at 12:21:30PM -0700, Juan Batiz-Benet wrote [1]: > Maybe also include: > > ```go > routing/...: > Routing system interface and implementations. > For example, the IPFS DHT lives here. > > exchange/...: > Exchange system interface and implementations > For example, Bitswap lives here. > ``` [1]: ipfs#1185 (comment)
wking
added a commit
to wking/go-ipfs
that referenced
this pull request
May 4, 2015
On Sat, May 02, 2015 at 12:21:30PM -0700, Juan Batiz-Benet wrote [1]: > Maybe also include: > > ```go > routing/...: > Routing system interface and implementations. > For example, the IPFS DHT lives here. > > exchange/...: > Exchange system interface and implementations > For example, Bitswap lives here. > ``` [1]: ipfs#1185 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've been chipping away at this over the past two days while I survey
the repository. Currently stumping me for a description is
core/corerouting, so I'd welcome some ideas for a brief description
there. Otherwise, I'm trying to describe these packages based on a
quick skim, so feedback/clarification/fixes/etc. are welcome :).
I still have a few more packages to document, but I thought I'd push
this PR now to start getting feedback on the earlier docs while I work
through the remaining packages.