1
gorenbk
360d

I made a database called SquareDB. Someone needs to help document it!

Project Type
Existing open source project
Summary

I made a database called SquareDB. Someone needs to help document it!

Description
Hi all! I recently built a database called SquareDB. I really need someone to document it. If this means anything to you, it’s also an hacktoberfest project. I would really help if someone contributed. Someone needs to document this, and that could be you!
Tech Stack
rust, axum, rocksdb
Current Team Size
1
URL
Comments
  • 0
    Use an LLM to generate docstrings then generate the docs from that.
  • 1
    @lungdart please, im not against LLMs, but we haven’t reached agi yet and they produce buggy code
  • 2
    "Someone needs to document this, and that could be you!" Fuck off.

    I'm really split between thinking whether it's a case of "I'm too lazy to do it myself and I think I'm owed help, so help me" or a genuine case of wanting for help but not knowing how to ask nicely.
    Because the words you use make it sound like the first case.
    If it's the first. Fuck off, learn some manners, nobody *needs* to do it for you.
    If it's the second and you're just weird/don't how to ask, well... Not like that. At very least write it in a way that actually makes someone want to help you when reading it, instead of writing it in a demanding language. You'd be surprised how many people are willing to help if you just ask nicely.
  • 2
    @SoldierOfCode im sorry, okay? i don't think i'm owed anything, but if you want to contribute, i'd be happy. you really don't need to be so hostile. i tried to ask nicely, okay?
  • 1
    @gorenbk 1) yes, they produce buggy code.

    so do people.

    what's your point?

    2) the suggestion was not to let the LLM write _code_ but _documentation_.

    which you'd have to double-check anyway, even if written by a human.

    so..
  • 0
    I'll check it out. I love databases and I love documentation ...

    Documentation is like pizza; when it's excellent that's wonderful, but even when it's not so great it's still better than not having any.
  • 0
    @SoldierOfCode English may not be their first language. I can appreciate "someone needs to document it" may not come across the same way as "I'm really hoping for someone to help me document it, and I'd be extremely grateful" but I don't think it deserved the harshness of your response.
  • 0
    @gorenbk last check-in was three months ago. Is this still under development?
  • 0
    I'm going to go with 'no'.
Add Comment