Skip to content

Commit ec6a782

Browse files
tobil4skSimn
authored andcommitted
Update documentation for VcsData methods
Add a description for isReproducible() and clairfy the purpose of getCleaned()
1 parent 3f68e11 commit ec6a782

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/haxelib/VersionData.hx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,17 @@ class VcsData {
6262
url;
6363
}
6464

65+
/**
66+
Returns whether this vcs data will always reproduce an identical installation
67+
(i.e. the commit id is locked down)
68+
**/
6569
public function isReproducible() {
6670
return commit != null;
6771
}
6872

6973
/**
70-
Returns an object containing the filled-in VcsData fields,
71-
without the empty ones.
74+
Returns an anonymous object containing only the non-null, non-empty VcsData fields,
75+
excluding the null/empty ones.
7276
**/
7377
public function getCleaned() {
7478
var data:{

0 commit comments

Comments
 (0)