4 ms·
https://yaroslav.io/opensource/kino https://yaroslav.io/opensource/kino Where is the documentation? I am sorry but this is really a problem in the ruby world.
by shevy-java 1mo ago
https://yaroslav.io/opensource/kino https://yaroslav.io/opensource/kino
Where is the documentation?
I am sorry but this is really a problem in the ruby world. Everyone sees how much ruby is struggling right now, yet key problems, such as documentation, are not a focus. Look at rack, ruby-wasm, ruby-opal and many other projects. Too many ruby developers hate documentation. There are a few exceptions (Jeremy Evans projects typically have a strong focus on documentation, for instance), but by and large I don't understand why documentation is always an afterthought of most projects.
If you look at the github page at https://github.com/yaroslav/kino https://github.com/yaroslav/kino, and search for the keyword "documentation", you get zero results. I would instead have expected at the least a link with extensive documentation, both project-internally, but more importantly, via specific examples, a useful FAQ, and most importantly a kind of extensive "how to use this". Even ruby on rails, by the way, understood that this is important, and they have a tutorial (how useful that is, is another topic, but at the least rails people understand that documentation is important; see here: https://guides.rubyonrails.org/getting_started.html https://guides.rubyonrails.org/getting_started.html)
Edit:
They have on directory called doc/ here at:
https://github.com/yaroslav/kino/tree/main/doc https://github.com/yaroslav/kino/tree/main/doc
But have a look at this:
"Almost all content here is written by agents (Claude Code or Codex)."
When a project is too lazy to write documentation by a human, and instead resorts to AI slop spam, then why should real human use this? I don't get it. Is the ruby world nuts now? All that pointless AI slop spam? A lot of it is unreadable to me, it makes no sense. I am noticing this with Hiroshi Shibata, before he had difficulty with english, now he writes perfect english - aka AI slop. And the generated words STILL MAKE NO REAL SENSE. I read a lot of it and it is gibberish nonsense. It is like babelfish, only slightly improved. Mankind is actively getting dumber now.
- digitaltrees 1mo agoRuby code is readable. So some of the documentation in say, Java, isn’t as necessary.
- paulryanrogers 1mo agoDebatable. I always found languages without parentheses inscrutable. To distinguish methods you have to have all method signatures memorized or rely on an advanced IDE with highlighting.
- bluerooibos 1mo ago> inscrutable. To distinguish methods you have to have all method signatures memorized or rely on an advanced IDE with highlighting. I'm confident that you're either an outlier or have simply come across a terribly written or badly formatted Ruby codebase - considering Ruby (and Rails which followed the same principles) was created with the purpose of being highly readable (made for humans [1]). What is advanced IDE highlighting? Do you mean.. colours? And memorising methods - huh? I really struggle to see how you can't tell which lines here are methods - https://gist.github.com/davidlares/5d136fa54572ad98e711e36843dc4410 https://gist.github.com/davidlares/5d136fa54572ad98e711e3684... [1] https://news.ycombinator.com/item?id=22090358 https://news.ycombinator.com/item?id=22090358
- paulryanrogers 1mo agoI don't mean method definitions. I mean method invocations.
- bluerooibos 1mo agoI see. In almost 10 years of using Ruby I can't say that ever bothered me.
- pmontra 1mo agoThe guidelines I remember are no parentheses for DSLs, e.g. the Rails validation methods or the associations, and parentheses for the other methods.
- digitaltrees 1mo agoBut you can literally inspect and interrogate objects. You can ask what methods exist. You can even make new methods at run time.
- azuanrb 1mo agoPeople love taking generic engineering problems and somehow spinning them as Ruby specific issues. None of the issues you mentioned have anything to do with Ruby. They’re problems you can run into in any engineering project.