Merge pull request #15 from jbytecode/main

add docstring for loftlinear
COMODO-research · Mar 5, 2024 · 686d6ef · 686d6ef
2 parents 561fadb + 9b87e52
commit 686d6ef
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,4 @@
+# Comodo.jl
+
+___________________
+
diff --git a/src/functions.jl b/src/functions.jl
@@ -1535,6 +1535,16 @@ function circlepoints(f::FunctionType,n; dir=:acw) where {FunctionType <: Functi
     end
 end
 
+"""
+    loftlinear(V1,V2;num_steps=2,close_loop=true,face_type=:tri)
+
+    Apply loftlinear for given vectors 
+
+# Arguments:
+- `V1::Vector`: n-vector 
+- `V2::Vector`: n-vector
+
+"""
 function loftlinear(V1,V2;num_steps=2,close_loop=true,face_type=:tri)
     #=
     The `loftlinear` function spans a surface from input curve `V1` to curve