Add flake.nix #1
Conversation
|
|
||
| meta = { | ||
| description = "Efficient Bloom filters for OCaml"; | ||
| longDescription = |
There was a problem hiding this comment.
I think that a multiline Nix string would work here, like:
longDescription = ''
some text
across multiple
lines
'';
There was a problem hiding this comment.
I initially adapted this method when I was trying to stay below a certain line length. But then I realized being strict about this kinda also harm the readability by creating verbose expressions. I relaxed the line length rule on most places but I guess longDescription must have stayed like that.
The idea was to avoid line breaks that don't appear in the source text. When I do something like
longDescription = ''
Bloom filters are memory and time efficient data structures allowing
probabilistic membership queries in a set.\n A query negative result ensures
that the element is not present in the set, while a positive result might be
a false positive, i.e. the element might not be present and the BF membership
query can return true anyway.\n Internal parameters of the BF allow to
control its false positive rate depending on the expected number of elements
in it.
``;
the resulting string has unwanted line breaks.
I guess we could do
longDescription = ''
Bloom filters are memory and time efficient data structures allowing probabilistic membership queries in a set.
A query negative result ensures that the element is not present in the set, while a positive result might be a false positive, i.e. the element might not be present and the BF membership query can return true anyway.
Internal parameters of the BF allow to control its false positive rate depending on the expected number of elements in it.``;
If the length of the line is not a problem.
|
I created this branch to make the flake usable outside the source repository. While I am willing to to further work on this until it is in an acceptable state, the current effort will not be wasted if this PR is not accepted. |
I see that you are familiar with Nix ecosystem.
nix flake showproduces the following output with the added flake:`nix flake show` output