Sophia is a modern [should add comma] embeddable key-value database designed for a high [should hyphenate] load environment.
It has a unique architecture that was born as a result of research and rethinking primary alghorithmical [sic, should say "algorithm"] constraints associated with a [sic] getting popular Log-file based data structures, such as LSM-tree [should say "trees"], it's [sic] variations based on Fractional Cascading ideas and a B-Tree. (see architecture) [run-on, meaning unclear]
It is very fast. (see benchmarks)
it [sic] is easy to use. (see documentation)
Implemented as a small C [should probably hyphenate, or just rewrite] written, BSD [should probably hyphenate] licensed library.
To cite just one example, redis is widely considered excellent software, but much of its documentation is written in a very imperfect English.
English is not an easy second language to learn as an adult, and technical English doubly so.
The author's primary (and perhaps only) contact with users is through their documentation. Incorrect capitalization and apostrophe use is distracting and will put off some potential users. The author looks sloppy and uncaring because these types of mistakes are preventable.
Being a non-native speaker is not an excuse for basic errors (excepting novices). Proof-read your docs! If you're not confident in your language skills, ask someone else to!
I doubt it is the lack of time. But natively English-speaking acquaintance to proof-read technical documentation can be very hard to come by. Most projects have to do by with the folks they have. ( I am in need for such a person myself. If anyone has the time Searchdaimon ( https://github.com/searchdaimon/enterprise-search ) could need some help :) )
One trick can be to at least wikify the documentation so other can easier pitch in.
Instead of bashing someone on hnews comments, you could send them an errata patch.
But of course you want to make it clear that you feel no obligation to contribute despite your criticism. So it's lazy for him, but not for you?
Note I comment exclusively on the author's presentation, not thrir personal behavior: obviously they are not lazy. I have no obligation to contribute, no: ncome from or personal interest in this project. I contribute to the projects which benefit me and people who I care about.
rgbrgb, I agree that it's superficial, but in direct contrast to your praise of the superficial style of the documentation, I was unfortunately distracted by the superficial mistakes in grammar and spelling. I wish someone would take the time to help the author of this code, Dmitry Simonenko, to improve the documentation. To that point, here are my hopefully constructive criticisms specifically of the language used in the documentation. I have performed no audit of the library itself, and cannot speak to its quality.
Does this still come off to you as poor form?
The problem with the docs aren't these small gramattical errors. In most cases you cite the meaning is clear, so this is just pedantry.
What bothers me about the documentation is that the explanation of his algorithms is a bit opaque.
But all told, I'd much rather someone contribute than hold back because of concerns about language mastery.
I know my spoken and written english is far from perfect, but I can live with it.
"Algorithm" isn't an adjective. I accept "algorithmical", although it should probably be "algorithmic".
Memory isn't an adjective either, but the phrase "rethinking primary memory constraints" strikes me as perfectly valid. That's why I concluded that "algorithm" would be the most clear word. But yes, I think "algorithmic" would have been fine as well.
в следующий раз (кстати с заглавной буквы можно начать) перед тем как насилывать свою клаву, лучше пойди на подкурсы русского или китайского или хотя бы того же английского.
очень не сложно оставлять мусорные комментарии, не относящиеся кстати к теме разговора, и называть себя викинг кодером. гораздо сложнее соответствовать своему имени, и "викинговать" архитектуру, код, мысли, философию создания.
если бы в интернете и/или на хакер ньюз была бы общая корзина для мусора, и можно было бы голосовать за вещи которые туда отправляются, можешь расчитывать на мой голос.
hey VikingCoder, I heard you are a fan of grammar? see above? grammar that.
Since you're so good rummage in English grammar, and you so annoying lack of commas and hyphens, tell me how to better articulate and "prufridat" here is the comment, or ... you have this same emptiness in one part of your, grammatically sharpened the brain (where, incidentally, you can put a hyphen) prevents you meet the challenge? next time (by the way with a capital letter, you can start) before its nasilyvat Claudia, better go to the podkursy Russian or Chinese, or at least the same English. not very difficult to leave garbage comments not related to the topic of conversation by the way, and call themselves Viking encoder. much more difficult to live up to its name, and "vikingovat" architecture, code, thoughts, philosophy of creation. if the Internet and / or a hacker would Neuse total waste basket, and it was possible to vote for things that go there, you can count on my vote.
Then, in English:
> ... see above? grammar that.
First time I've heard "grammar" used as a verb. :)
document.getElementById("main").style.fontFamily = "sans-serif";