rune-rs / rune

An embeddable dynamic programming language for Rust.
https://rune-rs.github.io
Apache License 2.0
1.7k stars 85 forks source link

doc: Render the `any` type explicitly #765

Closed udoprog closed 1 month ago

udoprog commented 1 month ago

Relates #757

This ensures that if any dynamic type is supported by a method, it will be indicated using the new any placeholder.

image

This solves an ambiguity in documentation so we can differentiate between methods which return () (empty tuple) and any value like clone above.

Eventually with gradual typing this is expected to become a proper any type that can be used which essentially disables type checking.

Once it is a proper type it should also be documented.