this post was submitted on 03 Oct 2025
6 points (58.8% liked)

Programming

23003 readers
198 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev



founded 2 years ago
MODERATORS
 

cross-posted from: https://programming.dev/post/38477847

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 10 comments
sorted by: hot top controversial new old
[โ€“] asudox@lemmy.asudox.dev 6 points 6 days ago* (last edited 6 days ago) (2 children)

You can't write your own docs? Well, I guess nobody would use your shitty project anyway. Probably generated by an agent as well.

The name of this project is at least accurrate, but I have my suspicions that it is also generated by AI. OP, are you the "dev" of this?

[โ€“] Hundun@beehaw.org 1 points 2 days ago

That was mean as heck though. One can be correct and approachable at the same time.

[โ€“] exgf@programming.dev -3 points 6 days ago* (last edited 6 days ago) (3 children)

Well aren't you a bright little ray of light. At this moment your question is akin to saying "You can't write all the scaffolding instead of running cargo new --bin oh_wow_im_so_leet_i_disparage_my_brothers_and_sisters_sharing_open_source_software_for_free"

Go skim through my Github if you want to call me a "developer", pick a project and contribute.

Who in their right mind would sit around writing insane regex for weeks, of course this particular project was augmented with a conversation with an LLM.

Nice undocumented fork of project though. Proud of u.

[โ€“] Hundun@beehaw.org 2 points 2 days ago* (last edited 2 days ago)

My sibling in craft, docs are not "boilerplate", they are the main freaking sauce. That is why they should be written by a human who understands stuff. I genuinely believe you are missing the point of the practice.

[โ€“] UnRelatedBurner@sh.itjust.works 4 points 6 days ago (1 children)

hey, exgf, have you heard of a "ragebait"?

[โ€“] exgf@programming.dev 0 points 5 days ago

It's only effective if the person has actual done something.

[โ€“] asudox@lemmy.asudox.dev 2 points 6 days ago

Is that so? Have a nice day, bud.

[โ€“] locuester@lemmy.zip 4 points 6 days ago (2 children)

Nice project. Seems a bit heavy on the dependency side.

Psst: step 2 of the install instructions has a question to you from the LLM writing the docs. lol

[โ€“] exgf@programming.dev 1 points 5 days ago

Oof, thank you for the catch.

[โ€“] exgf@programming.dev 0 points 5 days ago

Every project is way too heavy on the dependency side imo, removing as many deps as I can from my projects is on the TODO list.