berry
berry copied to clipboard
[Feature] documentation for how to debug constraints
- [ ] I'd be willing to implement this feature (contributing guide)
- [x] This feature is important to have in this repository; a contrib plugin wouldn't do
Describe the user story
Example: "As a developer, I need to know how to debug constraints".
Describe the solution you'd like
documentation!!! an interpreter isn't going to know your functions or variables unless you tell us how or where. Speaking of variables/inputs document those please, looking at the common ones, I'm like huh? magic inputs!!! I have no idea how to start modifying this from your documentation, or debug it when I get it wrong. Right now I just want to modify this to exclude dev deps.
Describe alternatives you've considered
bashing my head against a wall until I don't care.
Describe the user story
I'm an open-source project maintainer. I like my project, so I want to help people using it. To this end, I write documentation and try to answer questions whenever I have the time. Sometimes people come and take the liberty of ranting against said documentation (and sometimes project) in a fairly unprofessional way.
Describe the solution you'd like
Have those users realize that no one is going to be motivated to answer an issue that verbally implies something sucks, when we have so many more interesting tasks that other people took the time to write in a proper way (ie not intended to make us feel like shit). Get them to understand that "rewrite the documentation" isn't actionable, and that concrete incremental PRs would be a little more helpful.
Describe alternatives you've considered
I could close these issues and ask their authors to Be The Change by submitting a PR improving the documentation themselves, since they seem to think being a technical writer is easy peasy, but I still hope to avoid that. Might have to, though.
seriously? I mean, how does someone who can't figure it out, write the documentation on how to figure it out? oh I suppose I could go source diving. I too am an open source author, or was, I don't really maintain anything anymore. You have documentation, it's there, I was able to use the examples provided, I just don't feel like enough documentation was provided to modify them. There are magic variables that I can't print the contents of out because I don't know how (well, maybe I can insert print statements?), those variables don't appear to be documented. Not sure what you want from me here though that I got your rant.