Prevent printing No documentation found when result is not empty

Author: vsbogd

lib/src/metta/runner/stdlib/mod.rs

@@ -689,13 +689,7 @@ mod tests {
             !(get-doc &self NoSuchAtom)
         "#);
 
-        assert_eq_metta_results!(metta.run(parser), Ok(vec![
-            vec![expr!("@doc-formal"
-                ("@item" "NoSuchAtom")
-                ("@kind" "atom")
-                ("@type" "%Undefined%")
-                ("@desc" {Str::from_str("No documentation")}) )],
-        ]));
+        assert_eq_metta_results!(metta.run(parser), Ok(vec![vec![]]));
     }
 
     #[test]
@@ -718,13 +712,7 @@ mod tests {
             !(get-doc &self (some-func arg1 arg2))
         "#);
 
-        assert_eq_metta_results!(metta.run(parser), Ok(vec![
-            vec![expr!("@doc-formal"
-                ("@item" ("some-func" "arg1" "arg2"))
-                ("@kind" "atom")
-                ("@type" "RetType")
-                ("@desc" {Str::from_str("No documentation")}) )],
-        ]));
+        assert_eq_metta_results!(metta.run(parser), Ok(vec![vec![]]));
     }
 
     #[test]

lib/src/metta/runner/stdlib/stdlib.metta

@@ -825,7 +825,7 @@
     (let $type' (if (== $type %Undefined%) (undefined-doc-function-type $params) (cdr-atom $type))
     (let ($params' $ret') (get-doc-params $params $ret $type')
       (@doc-formal (@item $name) (@kind function) (@type $type) $desc (@params $params') $ret')))
-    (@doc-formal (@item $name) (@kind function) (@type $type) (@desc "No documentation")) ))
+    Empty ))
 
 (@doc undefined-doc-function-type
   (@desc "Function used by get-doc-single-atom in case of absence of function's type notation")
@@ -872,7 +872,7 @@
       (@doc-formal (@item $atom) (@kind atom) (@type $type) $desc)
       (unify $space (@doc $atom $desc' (@params $params) $ret)
         (get-doc-function $space $atom %Undefined%)
-        (@doc-formal (@item $atom) (@kind atom) (@type $type) (@desc "No documentation")) ))))
+        Empty ))))
 
 (@doc help!
   (@desc "Function prints documentation for the input atom or module. Without parameters prints the list of the corelib functions.")
@@ -881,6 +881,15 @@
   (@return "Unit atom"))
 (: help! (-> Atom (->)))
 (= (help! $atom)
+  (case (help-internal! $atom) (
+    (Empty (println! (format-args "No documentation found for {}" ($atom))))
+    ($other $other) )))
+
+(: help! (-> (->)))
+(= (help!) (help! corelib))
+
+(: help-internal! (-> Atom (->)))
+(= (help-internal! $atom)
   (let $top-space (mod-space! top)
   (case (get-doc $top-space $atom) (
     ((@doc-formal (@item $item) (@kind function) (@type $type) (@desc $descr)
@@ -897,15 +906,14 @@
     ((@doc-formal (@item $item) (@kind atom) (@type $type) (@desc $descr))
       (let () (println! (format-args "Atom {}: {} {}" ($item $type $descr)))
       () ))
+    (Empty Empty)
     ($other (Error $other "Cannot match @doc-formal structure") )))))
 
-(: help! (-> Symbol (->)))
-(= (help! $mod)
-  (let $space (module-space-no-deps (mod-space! $mod))
-    (help-space! $space) ))
-
-(: help! (-> (->)))
-(= (help!) (help! corelib))
+(: help-internal! (-> Symbol (->)))
+(= (help-internal! $mod)
+  (case (module-space-no-deps (mod-space! $mod)) (
+    ((Error $atom $msg) Empty) ; return Empty because other instance returns ()
+    ($space (help-space! $space)) )))
 
 (@doc help-space!
   (@desc "Function prints documentation for all of the atoms from the given space.")
@@ -914,13 +922,15 @@
   (@return "Unit atom"))
 (: help-space! (-> SpaceType (->)))
 (= (help-space! $space)
-    (unify $space (@doc $name (@desc $desc) $params $ret)
-      (let () (println! (format-args "{}\n\t{}" ($name $desc))) Empty)
-      Empty))
+    (let $_ (collapse
+      (unify $space (@doc $name (@desc $desc) $params $ret)
+        (let () (println! (format-args "{}\n\t{}" ($name $desc))) Empty)
+        Empty )) ()))
 (= (help-space! $space)
-    (unify $space (@doc $name (@desc $desc))
-      (let () (println! (format-args "{}\n\t{}" ($name $desc))) Empty)
-      Empty))
+    (let $_ (collapse
+      (unify $space (@doc $name (@desc $desc))
+        (let () (println! (format-args "{}\n\t{}" ($name $desc))) Empty)
+        Empty )) Empty)) ; return Empty because other instance returns ()
 
 (@doc help-param!
   (@desc "Function used by function help! to output parameters using println!")

python/tests/scripts/g1_docs.metta

@@ -67,13 +67,13 @@
 ; description.
 !(assertEqual
    (get-doc NoSuchAtom)
-   (@doc-formal (@item NoSuchAtom) (@kind atom) (@type %Undefined%) (@desc "No documentation")))
+   Empty)
 
 ; Same result is returned if for instance documentation for the function
 ; application is queried.
 !(assertEqual
    (get-doc (some-func arg1 arg2))
-   (@doc-formal (@item (some-func arg1 arg2)) (@kind atom) (@type ReturnType) (@desc "No documentation")))
+   Empty)
 
 ; `help!` function gets the documentation and prints it in a human readable
 ; format.