ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Start to rework some of our kcl docs (#3222)

Browse Source 
* Start to rework some of our kcl docs

Signed-off-by: Paul R. Tagliamonte <paul@zoo.dev>
This commit is contained in:
Paul Tagliamonte
2024-08-06 20:27:26 -04:00
committed by GitHub
parent 5cb5dbd689
commit e1c45bdb33
81 changed files with 423 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/wasm-lib/kcl/src/std/mod.rs
View File

@ -212,14 +212,14 @@ pub enum FunctionKind {
UserDefined,
}
/// Returns the length of the given leg.
/// Compute the length of the given leg.
pub async fn leg_length(args: Args) -> Result<MemoryItem, KclError> {
let (hypotenuse, leg) = args.get_hypotenuse_leg()?;
let result = inner_leg_length(hypotenuse, leg);
args.make_user_val_from_f64(result)
}
/// Returns the length of the given leg.
/// Compute the length of the given leg.
///
/// ```no_run
/// legLen(5, 3)
@ -232,14 +232,14 @@ fn inner_leg_length(hypotenuse: f64, leg: f64) -> f64 {
(hypotenuse.powi(2) - f64::min(hypotenuse.abs(), leg.abs()).powi(2)).sqrt()
}
/// Returns the angle of the given leg for x.
/// Compute the angle of the given leg for x.
pub async fn leg_angle_x(args: Args) -> Result<MemoryItem, KclError> {
let (hypotenuse, leg) = args.get_hypotenuse_leg()?;
let result = inner_leg_angle_x(hypotenuse, leg);
args.make_user_val_from_f64(result)
}
/// Returns the angle of the given leg for x.
/// Compute the angle of the given leg for x.
///
/// ```no_run
/// legAngX(5, 3)
@ -252,14 +252,14 @@ fn inner_leg_angle_x(hypotenuse: f64, leg: f64) -> f64 {
(leg.min(hypotenuse) / hypotenuse).acos().to_degrees()
}
/// Returns the angle of the given leg for y.
/// Compute the angle of the given leg for y.
pub async fn leg_angle_y(args: Args) -> Result<MemoryItem, KclError> {
let (hypotenuse, leg) = args.get_hypotenuse_leg()?;
let result = inner_leg_angle_y(hypotenuse, leg);
args.make_user_val_from_f64(result)
}
/// Returns the angle of the given leg for y.
/// Compute the angle of the given leg for y.
///
/// ```no_run
/// legAngY(5, 3)