Skip to content

Commit

Permalink
Make constructor docs into judoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
paulcadman authored and janmasrovira committed Oct 27, 2023
1 parent 346658f commit 25d3a8e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions include/package/PackageDescription.juvix
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,19 @@ defaultVersion : SemVer := mkVersion 0 0 0;

--- A ;Dependency; defines a Juvix package dependency.
type Dependency :=
-- A filesystem path to another Juvix Package.
| path {path : String}
-- A ;git; repository containing a Juvix package at its root
| git {
| --- A filesystem path to another Juvix Package.
path {path : String}
| --- A ;git; repository containing a Juvix package at its root
git {
-- A name for this dependency
name : String;
-- The URL to the git repository
url : String;
-- The git ref to checkout
ref : String
}
-- The ;defaultStdlib; that is bundled with the Juvix compiler.
| defaultStdlib;
| --- The ;defaultStdlib; that is bundled with the Juvix compiler.
defaultStdlib;

--- Constructs a GitHub dependency.
github (org repo ref : String) : Dependency :=
Expand Down

0 comments on commit 25d3a8e

Please sign in to comment.