tealr VS docs.rs

working more on tealr more specifically tealr_doc_gen

Fixing some short comings in tealr that people discovered. Also, making hv_lua work with tealr and ideally start adding that fishfight.

Fantastic! Very happy to see this move forward at such a fast pace. We’re implementing scripting in Fish Fight via the tealr crate, which wraps mlua (and rlua).

Hopefully the last hand on https://github.com/lenscas/tealr for a new release. Mostly going over the documentation. Laying less emphasis on teal and more on "Hey, using this you can express a more typesafe api to lua and can actually easily document it.".

tealr, my wrapper around rlua and mlua to focus on (among other things) being better able to describe your api in the form of types: Getting it to a point to release a new version. Which is all about allowing people to document they API that they created for lua/teal. This documentation gets written to the definition files when generating them. In addition, you can also ask tealr to generate a instance.help(page:Option) method on your types. When doing this, the documentation gets made available through this function. By default it prints out "type level" documentation for this type, as well as what other pages are availalbe. When given a string, it shows the documentation for that page instead. Pages that belong to methods also automatically include the type signature.

This requires some new features in my Rust <-> Teal FFI library tealr https://github.com/lenscas/tealr which is now also close to getting a new release, with the only thing I want to do is fix how its TypedFunction work (right now, it always contains a lua function, even if it was made inside of Rust, which puts some needless limits on it).

After that it is time to finish mlua support for tealr . As well as making it better at dealing with api's like tealsql has made.

In case anyone is interested: Issue about it here https://github.com/lenscas/tealr/issues/17

Can you try removing the println! at https://github.com/lenscas/tealr/blob/cee2363a14c53b995a69efb2b4cbd84010905276/tealr_derive/src/lib.rs#L155?

Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.

📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.

Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.

I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.

[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.

docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar

There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices

OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.