feature request: add "alias information to var meta"

[behrica]

I was thinking about potential re-use of "examples" in other contexts,

The current var metadata of a symbol with attahced example-seesion, returns:

• original example code as "string"
• each "line" of the exampl-session as a fn, ready to execute

maybe in some contexts it would be nice to know the aliases as well.
So that when having:

:metadoc/examples [(example-session
                       "Train random-forest on iris data"
                       (def training-data
                         (->
                          (scicloj.metamorph.ml.rdatasets/datasets-iris)
                          (ds/drop-columns [:rownames])
                          (ds-mod/set-inference-target [:species])))
                       (def model
                         (scicloj.metamorph.ml/train training-data {:model-type :metamorph.ml/random-forest}))
                       (comment "forest with hundred trees created")
                       (-> model :model-data :forest :trees count)
                       )
                      ]

we can now that alias "ds" aliases to tech.v3.dataset

I think your code could discover this at runtime

[behrica]

I am thinking about "re-use" of the attached examples.
I triggered a discussion here:

#kindly-dev > combine kindly/doc with metadoc examples

[genmeblog]

I don't think it's possible. It's done at the macro level by calling zprint-str on the code form.

[behrica]

I am looking for something like:

(example (zprint-str (s/reverse (str (+ 9 1)))))

;;=> {:test-value nil,
;;    :type :simple,
;;    :example-fn #function[metadoc.examples/eval27132/fn--27133],
;;    :example "(zprint-str (s/reverse (str (+ 9 1))))",
;;    :aliases
;;    {"+" "clojure.core/+",
;;     "str" "clojure.core/str",
;;     "s/reverse" "clojure.string/reverse",
;;     "zprint-str" "zprint.core/zprint-str"},
;;    :doc "Usage"}

or

(example (zprint-str (s/reverse (str (+ 9 1)))))
;;=> {:test-value nil,
;;    :type :simple,
;;    :example-fn #function[metadoc.examples/eval27212/fn--27213],
;;    :example-resolved
;;    "(zprint.core/zprint-str (clojure.string/reverse (clojure.core/str\n                                                 (clojure.core/+ 9 1))))",
;;    :example "(zprint-str (s/reverse (str (+ 9 1))))",
;;    :aliases
;;    {"+" "clojure.core/+",
;;     "str" "clojure.core/str",
;;     "s/reverse" "clojure.string/reverse",
;;     "zprint-str" "zprint.core/zprint-str"},
;;    :doc "Usage"}

Otherwise we loose the 'alias' information

[genmeblog]

It would require much more form analysis. I propose to avoid aliases or add manually relevant information to a namespace docstring.
As I wrote in the other issue, the main goal was to instrument functions with unit examples. Which - I agree - can be limiting.

[behrica]

Not much more. It's easy to "walk" over a form, detect "symbols" (always in first position of a 'list) and resolve them.
I might try it a bit,