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.

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

Docs #14

Merged
merged 5 commits into from
May 12, 2019
Merged

Docs #14

merged 5 commits into from
May 12, 2019

Conversation

Nemo157
Copy link
Member

@Nemo157 Nemo157 commented May 11, 2019

Description

Rearrange public API and add trivial documentation to it all.

Main changes in the module structure/type names:

  • Switch to the Encoder/Decoder naming scheme used in all of flate2, brotli2, zstd.
  • Remove stuttering in type names by dropping the layer of compression-type modules.
  • Moving the compression-library specific configuration types into top-level re-exporting modules.

Motivation and Context

Consistency with existing libraries, ease of use.

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Nemo157
Copy link
Member Author

Nemo157 commented May 11, 2019

r? @fairingrey

@fairingrey
Copy link
Contributor

I agree with these changes, I think they'll make for a friendlier API. It always bothered me that the API changes I made were stuttering.

Thanks for your hard work, approved 👍

I'll be merging and refactoring #13 to fall in accordance with this PR once its' merged.

@fairingrey fairingrey mentioned this pull request May 12, 2019
8 tasks
@Nemo157 Nemo157 merged commit a36090e into Nullus157:master May 12, 2019
@Nemo157 Nemo157 deleted the docs branch May 12, 2019 10:02
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.

2 participants