search

ruby-numo / numo-narray

Ruby/Numo::NArray - New NArray class library
http://ruby-numo.github.io/narray/
BSD 3-Clause "New" or "Revised" License
413 stars 41 forks source link

Fix README.md #177

Closed kojix2 closed 3 years ago

kojix2 commented 3 years ago

I don't think the documentation is primitive. There are too few developers, despite the fact that this is an important project used all over the world. Given this, the documentation is not the best, but it is good enough. It's not primitive at all.

orlando-labs commented 3 years ago

I fact, it's at maximum mediocre comparing to something people used to see in the Python world. I admit, the project is vital, and ruby needs scientific applications as a language. So I think there's a need to search for contributors somehow, not to mask the lack of good docs.

kojix2 commented 3 years ago

So how do you think we can find contributors?

orlando-labs commented 3 years ago

Near nowhere, I assume, until it's a sponsored project :( But it's still not a reason to remove a note about the obvious need for documentation quality bump.

kojix2 commented 3 years ago

The criterion is whether or not we are doing a good job within the scope of sustainability. It is not a comparison with Python or larger projects.

Projects in the Python community are not always sustainable. They have a beautiful brilliance that only exists at a time when large numbers of newcomers are entering the market. Ruby is not, and never will be, so it would be a kind of arrogance to think that it can maintain the same level of documentation as the Python projects. This is just my personal opinion, though.

orlando-labs commented 3 years ago

There's no way to avoid comparison as the world of programming offers tons of tools and opportunities. And, looking around, Numo is somewhat sustainable, and I, personally, use it and value it in a vast row of projects. I'm paying respect to its authors and contributors. But I find its docs poor (again, comparing to something the documentation should look and feel like in 2020).

orlando-labs commented 3 years ago

@kojix2, I got your point, but I have to say that wave of newcomers brings that small part of contributors at last. I'd really wanted to help easing the usage of Numo for developers with some shiny interactive example-rich docs, but currently I have no free resources after main projects and within one's power contributions to torch and torchaudio ruby ports.

kojix2 commented 3 years ago

Enough time has passed that this pull request will be dropped.