generate kcl examples in docs from macro (#1710)

* rearrange Signed-off-by: Jess Frazelle <github@jessfraz.com> * examples Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * recast Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add more tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * add more samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * more docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * more Signed-off-by: Jess Frazelle <github@jessfraz.com> * more samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * more Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * make serial Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix hang Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix import Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * atan Signed-off-by: Jess Frazelle <github@jessfraz.com> * atan Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * make all tests pass Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * must have code balock Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * new docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * new docs Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2024-03-13 12:56:46 -07:00
parent 6bab45a56a
commit a60bdd4cc3
36 changed files with 3584 additions and 538 deletions
--- a/src/wasm-lib/kcl/src/std/mod.rs
+++ b/src/wasm-lib/kcl/src/std/mod.rs
@ -24,7 +24,6 @@ use serde::{Deserialize, Serialize};
 use crate::{
    ast::types::parse_json_number_as_f64,
    docs::StdLibFn,
-    engine::EngineManager,
    errors::{KclError, KclErrorDetails},
    executor::{
        ExecutorContext, ExtrudeGroup, MemoryItem, Metadata, SketchGroup, SketchGroupSet, SketchSurface, SourceRange,
@ -760,6 +759,10 @@ pub async fn leg_length(args: Args) -> Result<MemoryItem, KclError> {
 }

 /// Returns the length of the given leg.
+///
+/// ```no_run
+/// legLen(5, 3)
+/// ```
 #[stdlib {
    name = "legLen",
 }]
@ -775,6 +778,10 @@ pub async fn leg_angle_x(args: Args) -> Result<MemoryItem, KclError> {
 }

 /// Returns the angle of the given leg for x.
+///
+/// ```no_run
+/// legAngX(5, 3)
+/// ```
 #[stdlib {
    name = "legAngX",
 }]
@ -790,6 +797,10 @@ pub async fn leg_angle_y(args: Args) -> Result<MemoryItem, KclError> {
 }

 /// Returns the angle of the given leg for y.
+///
+/// ```no_run
+/// legAngY(5, 3)
+/// ```
 #[stdlib {
    name = "legAngY",
 }]
@ -868,6 +879,16 @@ mod tests {
            fn_docs.push_str(&signature);
            fn_docs.push_str("\n```\n\n");

+            if !internal_fn.examples().is_empty() {
+                fn_docs.push_str("#### Examples\n\n");
+
+                for example in internal_fn.examples() {
+                    fn_docs.push_str("```kcl\n");
+                    fn_docs.push_str(&example);
+                    fn_docs.push_str("\n```\n\n");
+                }
+            }
+
            fn_docs.push_str("#### Arguments\n\n");
            for arg in internal_fn.args() {
                let (format, should_be_indented) = arg.get_type_string().unwrap();