Awful Rustdocs is a CLI tool that generates or improves Rustdoc comments by harvesting symbols via rust_ast.nu, enriching each item with ast-grep context (callers, intra-body calls, qualified paths), and prompting your LLM to produce concise, high-quality docs.

You don't need hundreds of prompts and agents if you're smart about your context.

I'm running it on all my Rust projects right now using the Systems Programming Qwen 3 4B finetune I created, and it saves me an incredible amount of time by creating docs that are almost always good enough to publish straight off but act more as a draft for me. It cuts down on a lot of repetitive typing and lets me get back to doing what I love (writing code).

It requires Nushell, but you should probably already be using that, and if this is how you find out about Nushell, then even better, make the jump; it's worth it.

top 4 comments

sorted by: hot top controversial new old

[–] balsoft@lemmy.ml 4 points 4 months ago (1 children)

IMHO generated docs (and yes, LLM spitting out stuff is generated docs) should not be committed to the repo. Something like this should happen on the cargo doc/docs.rs side (with opt-in from the user, of course). This has a couple major benefits, the main one being that the docs can improve as the LLM improves.

[–] exgf@programming.dev 2 points 4 months ago

I am in total agreement EXCEPT where I differ is that I believe no autogenerated docs should be committed to the repo without being proofread and improved. I see it like scaffolding.

[–] SanctimoniousApe@lemmings.world 2 points 4 months ago (1 children)

Who's "Agent Spaghetti,' and what do they want?

[–] exgf@programming.dev 1 points 4 months ago

😂😂😭