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

Feat/doc interfaces #4599

Merged
merged 15 commits into from
Jan 24, 2018
Merged

Feat/doc interfaces #4599

merged 15 commits into from
Jan 24, 2018

Conversation

whyrusleeping
Copy link
Member

Document interfaces

@whyrusleeping
interface docs for pinner
ce57a76 
License: MIT
Signed-off-by: Jeromy <[email protected]>
@ghost ghost assigned whyrusleeping Jan 21, 2018
@ghost ghost added the status/in-progress In progress label Jan 21, 2018
karalabe
karalabe reviewed Jan 21, 2018
View reviewed changes
blocks/blockstore/blockstore.go Outdated
@@ -40,12 +40,19 @@ type Blockstore interface {
DeleteBlock(*cid.Cid) error
Has(*cid.Cid) (bool, error)
Get(*cid.Cid) (blocks.Block, error)

// AddBlock puts a given block to the underlying datastore
Copy link
Contributor

Choose a reason for hiding this comment

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

Definitely wrong method name here :D

Copy link
Member Author

Choose a reason for hiding this comment

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

mmmm, copy paste has not served me well

@whyrusleeping
data storage interfaces
e0e856a 
License: MIT
Signed-off-by: Jeromy <[email protected]>
@whyrusleeping
Copy link
Member Author

@karalabe Any other bits that feel neglected?

whyrusleeping and others added 2 commits January 22, 2018 11:20
@whyrusleeping
keystore interface docs
76907bb 
License: MIT
Signed-off-by: Jeromy <[email protected]>
@frrist
docs for core builder NewNode method
e5f2f56 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@ghost ghost assigned frrist Jan 22, 2018
whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/core.go Outdated
@@ -670,6 +676,7 @@ func (n *IpfsNode) loadID() error {
return nil
}

// GetKey will return the IpfsNode key with name `name`.
Copy link
Member Author

Choose a reason for hiding this comment

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

maybe private key or keystore key instead of IpfsNode key

whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/coreapi/coreapi.go Outdated
func NewCoreAPI(n *core.IpfsNode) coreiface.CoreAPI {
api := &CoreAPI{n}
return api
}

// Unixfs returns the Unixfs API.
Copy link
Member Author

Choose a reason for hiding this comment

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

I feel like there should be a thing after API...

// Unixfs returns the Unixfs API *doodad*

thoughts @magik6k @lgierth ?

Copy link
Member

@frrist frrist Jan 22, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

how about interface? - If we like that, i'll put it on the others below

whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/coreapi/interface/interface.go Outdated
String() string
// Cid returns path cid
Copy link
Member Author

Choose a reason for hiding this comment

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

returns the cid that the path refers to. (as opposed to the root)

whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/coreapi/interface/interface.go Outdated
Root() *cid.Cid
// Resolved returns whether cid is nil
Copy link
Member Author

Choose a reason for hiding this comment

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

While this may be technically true, I think we want to say whether or not this path has been fully resolved.

cc @magik6k @lgierth

whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/coreapi/interface/interface.go Outdated
Name() string
//Path returns key path
Copy link
Member Author

Choose a reason for hiding this comment

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

space before Path

whyrusleeping
whyrusleeping commented Jan 22, 2018
View reviewed changes
core/coreapi/name.go Outdated
func (e *ipnsEntry) Name() string {
return e.name
}

// Value returns the inpnEntry value.
Copy link
Member Author

Choose a reason for hiding this comment

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

typo

@whyrusleeping
Copy link
Member Author

@magik6k wanna give this another look over?

@frrist frrist force-pushed the feat/doc-interfaces branch from 8186aed to af210f6 Compare January 23, 2018 00:22
frrist added 11 commits January 22, 2018 16:24
@frrist
docs for core/core method impls
738f182 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreapi method impls
1eee9e2 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreapi dag method impls
704534e 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
interface docs for coreapi interface
132c939 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreapi key method impls
252ddc8 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreapi name method impls
600bd08 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreapi unixfs method impls
8637bbc 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for coreunix add method impls
1c11496 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
interface docs for merkledag
c73493e 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for mfs system method impls
d3f5ee2 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist
docs for pin method impls
83ccc7e 
License: MIT
Signed-off-by: ForrestWeston <[email protected]>
@frrist frrist force-pushed the feat/doc-interfaces branch from af210f6 to 83ccc7e Compare January 23, 2018 00:25
@whyrusleeping whyrusleeping merged commit cfdcd98 into master Jan 24, 2018
@whyrusleeping whyrusleeping deleted the feat/doc-interfaces branch January 24, 2018 22:02
@ghost ghost removed the status/in-progress In progress label Jan 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frrist frrist frrist left review comments

@karalabe karalabe karalabe left review comments

@magik6k magik6k magik6k approved these changes

Assignees

@whyrusleeping whyrusleeping

@frrist frrist

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@whyrusleeping @karalabe @magik6k @frrist