8
Generate and insert Rustdocs into your Rust projects without a huge model or agent spaghetti ๐Ÿฆ€ (github.com)
submitted 1 year ago by to c/programming@programming.dev
10 comments fedilink hide all child comments
 

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.

all 10 comments

sorted by: hot top controversial new old
[โ€“] 4 points 1 year 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

  • permalink
  • fedilink
  • source
  • hideshow 2 child comments
    •
    • [โ€“] 6 points 1 year ago* (last edited 1 year ago) (6 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?

  • permalink
  • fedilink
  • source
  • hideshow 6 child comments
    •
  • [โ€“] [S] -3 points 1 year ago* (4 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.

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 4 child comments
    •
  • [โ€“] 3 points 1 year 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.

  • permalink
  • fedilink
  • source
  • parent
    • 4 comments in c/rust@programming.dev view that post
    [โ€“] 4 points 1 year ago (1 child)

    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.

  • permalink
  • fedilink
  • source
  • hideshow 1 child comment
    •
    • [โ€“] 2 points 1 year ago (1 child)

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

  • permalink
  • fedilink
  • source
  • hideshow 1 child comment
    •