Repository navigation
Docs: the README's server command starts, and its claims match the code - #91
Merged
Merged
Conversation
The quick-start ran the server without CACHE_API_KEY, which it refuses to start without. The README also called the WAI server optional, where NovaCache.Server is always in the library and only the executable is behind -f server, and put one-shot xz decompression and zstd compression among the IO operations, where both are pure. The example prints a parse error instead of calling error, and the test command enables the tests, as CI's does. The xz sublibrary's comment says what it is and why, without the history.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README in the 0.12.0.0 tarball, the one Hackage shows, gave version bounds that exclude 0.12 itself; main's README fixed those, and this corrects what remained, each checked against the code:
exe/Main.hs:135-145refuses to start withoutCACHE_API_KEYunless given--allow-open-writes. The command now sets the variable, and the next line says what the flag does.NovaCache.Serveris in the library unconditionally, withwaiandhttp-typesunconditional dependencies; only the executable is behind-f server.Xz.decompressandZstd.compressare pure (Xz.hs:104,Zstd.hs:182); the streaming codecs and zstd and bzip2 decompression run inIO.error, and the test command passes--enable-tests, as ci.yml's does.A fragment records it for 0.12.0.1, which puts this README on Hackage.