Release mod 1.0

[vog]

No description provided.

[mseri]

opam is unable to unpack this file

[mseri]

It would be useful either in the library or in the opam file description (or both) to explain what does it mean that they are proper modulo operators and how to use them, especially for a 1.0 release.

[avsm]

@vog have you had a chance to look at the above? Happy to help with any questions you have about opam, if any, but you need to make the decisions about your own package.

[vog]

Thanks for your feedback.

I'll add an explanation.

However, I don't understand what you mean by "opam is unable to unpack this file". I just tested it by hand on a plain Debian system, where I can download and unpack the source archive without any errors or warnings:

$ curl -O https://gitlab.com/-/project/60374965/uploads/baf2217bcdcb1a66362ab6aa82c0fdf1/mod-1.0.tar.zst
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  4095  100  4095    0     0   8408      0 --:--:-- --:--:-- --:--:--  8408

$ tar xvf mod-1.0.tar.zst 
mod-1.0/LICENSE
mod-1.0/Makefile
mod-1.0/dune
mod-1.0/dune-project
mod-1.0/src/build/release
mod-1.0/src/lib/Makefile
mod-1.0/src/lib/Mod.ml
mod-1.0/src/lib/Mod.mli
mod-1.0/src/lib/dune
mod-1.0/src/test/Makefile
mod-1.0/src/test/Test.ml
mod-1.0/src/test/Test.t
mod-1.0/src/test/dune

[shonfeder]

@vog You can see the error in our CI here https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/e0e9c62df312c7a170343e5119054fa24510f25a/variant/compilers,4.14,mod.1.0

E.g.,

mod.1.0 is not installed. Install it? [y/n] y
The following actions will be performed:
=== install 2 packages
  - install dune 3.16.0       [required by mod]
  - install mod  1.0 (pinned)

<><> Processing actions <><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-> retrieved dune.3.16.0  (cached)
[ERROR] Failed to get sources of mod.1.0: Unknown archive type: /home/opam/.opam/download-cache/sha256/4f/4fef6f1e2c56813ad4da5131e90f3f31bf670a3d90e598fdb9be64f735638772
-> installed dune.3.16.0

#=== ERROR while fetching sources for mod.1.0 =================================#
OpamSolution.Fetch_fail("Could not extract archive:\nUnknown archive type: /home/opam/.opam/download-cache/sha256/4f/4fef6f1e2c56813ad4da5131e90f3f31bf670a3d90e598fdb9be64f735638772")

opam doesn't support the zst compression format currently. Thanks to this PR, we have planned work now to specify this in the manual (see ocaml/opam#6171), but you can currently see the supported formats here: https://github.com/shonfeder/opam/blob/main/src/core/opamSystem.ml#L830-L853

[yawaramin]

Hello, taking a look at the interface file here: https://gitlab.com/v0g/mod/-/blob/main/src/lib/Mod.mli?ref_type=heads

It seems like there are no docstrings (nor readme file), would you mind adding some docstrings that people could refer to? The reason I mention this is because publishing on the opam-repository will trigger the documentation to be built and served in the OCaml website. So it would be helpful if there was some documentation in the module.