Skip to content

Conversation

hacdias
Copy link
Member

@hacdias hacdias commented Dec 11, 2020

Exporting all the codecs constants makes the documentation (and the package) very cluttered. Look at this (you can barely find the functions in the docs):

Screen Shot 2020-12-11 at 18 01 24

With this, you can access multicodecs.codecs.YOUR_MARVELOUS_CODEC.

License: MIT
Signed-off-by: Henrique Dias [email protected]

License: MIT
Signed-off-by: Henrique Dias <[email protected]>
@hacdias hacdias requested review from mikeal, vmx and hugomrdias December 11, 2020 17:21
Copy link
Member

@vmx vmx left a comment

Choose a reason for hiding this comment

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

I would say that using the constants is the main purpose of this library, I'd keep them on the top level.

@hacdias
Copy link
Member Author

hacdias commented Dec 16, 2020

Thinking about it, I agree with @vmx so I will close this.

@hacdias hacdias closed this Dec 16, 2020
@hacdias hacdias deleted the breaking-consts branch December 16, 2020 17:31
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.

3 participants