doc: add docs to NewR1CS and NewSparseR1CS in system.go #985

Consensys · Jan 9, 2024 · 5fda666 · 5fda666
1 parent 7325f9d
commit 5fda666
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 1 deletion.
diff --git a/constraint/bls12-377/system.go b/constraint/bls12-377/system.go
diff --git a/constraint/bls12-381/system.go b/constraint/bls12-381/system.go
diff --git a/constraint/bls24-315/system.go b/constraint/bls24-315/system.go
diff --git a/constraint/bls24-317/system.go b/constraint/bls24-317/system.go
diff --git a/constraint/bn254/system.go b/constraint/bn254/system.go
diff --git a/constraint/bw6-633/system.go b/constraint/bw6-633/system.go
diff --git a/constraint/bw6-761/system.go b/constraint/bw6-761/system.go
diff --git a/constraint/tinyfield/system.go b/constraint/tinyfield/system.go
diff --git a/internal/generator/backend/template/representations/system.go.tmpl b/internal/generator/backend/template/representations/system.go.tmpl
@@ -25,11 +25,14 @@ type system struct {
 	field
 }
 
-
+// NewR1CS is a constructor for R1CS. It is meant to be use by gnark frontend only,
+// and should not be used by gnark users. See groth16.NewCS(...) instead.
 func NewR1CS(capacity int) *R1CS {
 	return newSystem(capacity, constraint.SystemR1CS)
 }
 
+// NewSparseR1CS is a constructor for SparseR1CS. It is meant to be use by gnark frontend only,
+// and should not be used by gnark users. See plonk.NewCS(...) instead.
 func NewSparseR1CS(capacity int) *SparseR1CS {
 	return newSystem(capacity, constraint.SystemSparseR1CS)
 }