Skip to content

Documentation: Replace the API example by a link to the API #6809

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.

Sign up for GitHub

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

Open
kit-ty-kate wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −11
Open

Documentation: Replace the API example by a link to the API #6809

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions doc/pages/Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,17 +374,8 @@ Here is a full example:
> Here is an example of an ordered sequence: `~~`, `~`, `~beta2`, `~beta10`,
> `0.1`, `1.0~beta`, `1.0`, `1.0-test`, `1.0.1`, `1.0.10`, `dev`, `trunk`.

For quick sanity checks, you can compare package versions using the OCaml REPL:

```
#use "topfind";;
#require "opam-core";;
# OpamVersionCompare.compare "1.2.10" "1.2.9";;
- : int = 1
```

You can also compare package versions using the `opam` command line (available
from opam version `2.4.0`):
For quick sanity checks, you can compare package versions using the `opam`
command line (available from opam version `2.4.0`):

```shell
$ opam admin compare-versions 1.2.10 1.2.9
Expand All @@ -401,6 +392,9 @@ $ opam admin compare-versions 0.0.9 --lt 0.0.10

Refer to the command help page for more details.

You can also use the [OpamVersionCompare](/doc/api/opam-core/OpamVersionCompare) API
for opam < `2.4.0` users.

### Variables

#### Usage
Expand Down
Loading