Skip to content
This repository has been archived by the owner on Sep 6, 2022. It is now read-only.

Fix documentation missmatch for crypto methods. #56

Merged
merged 1 commit into from
Dec 7, 2019

Conversation

JorikSchellekens
Copy link
Contributor

The docs seem to lie about what the ConfigEncodeKey and ConfigDecodeKey methods do. Currently they seem to simply be wrappers around base 64 encoding and decoding.

The simple fix is to update the docs but is it possible to get these methods
to marshal to public or private key correctly by passing a "type" (reflect.Type or something) to them?

(First day using go, otherwise I would have taken an actual stab at this)

The docs seem to lie about what these methods do.
This is the naive solution since it's my first day looking
at go but would it be possible to get these methods
to marshal to public or private key correctly by passing
a type to them?
@JorikSchellekens JorikSchellekens changed the title Fix documentation mix match for crypto methods. Fix documentation missmatch for crypto methods. Sep 4, 2019
@JorikSchellekens
Copy link
Contributor Author

This is not covered by #2

@JorikSchellekens
Copy link
Contributor Author

Also, I've no idea what the codecov is complaining about. This is a doc only change so far.

@JorikSchellekens
Copy link
Contributor Author

JorikSchellekens commented Sep 4, 2019

Would it make more sense to just have methods for both PrivateKeys and PublicKeys?

Copy link
Member

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

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

LGTM. I'm not sure why we even have these methods but we can look into removing them later.

@Stebalien Stebalien merged commit 54a9d30 into libp2p:master Dec 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants