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

Clarify that .sz refers to Google's Snappy format #563

Closed
ilyagr opened this issue Dec 3, 2023 · 0 comments · Fixed by #570
Closed

Clarify that .sz refers to Google's Snappy format #563

ilyagr opened this issue Dec 3, 2023 · 0 comments · Fixed by #570
Labels
documentation Improvements or additions to documentation

Comments

@ilyagr
Copy link
Contributor

ilyagr commented Dec 3, 2023

It needs to be disambiguated from the unfortunately named SZ compression.

You could just call it .sz (Snappy) in the README and the help text. Optionally, you can also link to https://github.com/google/snappy, but I don't think it's necessary.

I stumbled upon this since I became curious about what .sz meant, and it took me a surprising amount of time to figure it out.

@ilyagr ilyagr added the documentation Improvements or additions to documentation label Dec 3, 2023
ilyagr added a commit to ilyagr/ouch that referenced this issue Dec 5, 2023
It needs to be disambiguated from the unfortunately named
SZ compression, see https://szcompressor.org/.

Fixes ouch-org#563
ilyagr added a commit to ilyagr/ouch that referenced this issue Dec 5, 2023
It needs to be disambiguated from the unfortunately named
SZ compression, see https://szcompressor.org/.

Fixes ouch-org#563
marcospb19 pushed a commit that referenced this issue Dec 5, 2023
It needs to be disambiguated from the unfortunately named
SZ compression, see https://szcompressor.org/.

Fixes #563
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant