a detail you probably didn't know: nowhere in any #curl documentation do we use the word "very".
-
@bagder @gruber
Full list is here in case anyone else is curious like I was:
https://github.com/curl/curl/blob/master/.github/scripts/badwords.txt#L84 -
a detail you probably didn't know: nowhere in any #curl documentation do we use the word "very". It is a banned word enforced by a CI check. This rule encourages us to rewrite and instead use more appropriate words. Makes us write better English.
@bagder That is very interesting. But I wonder if it's very necessary?
-
-
@bagder is there a tool you’re using for this? I didn’t see it mentioned in the replies. I remember using something called Alex to do this in the past.
@iansu we have a custom script for it
-
@shaman007 it is too simple. There is almost always a better way to phrase the same thing without it. very happy = excited, very glad = thrilled, very hungry = starving, etc. So the use of "very" is a sign that it can be said better.
@bagder @shaman007 IMHO for technical documentation: simple is better. BTW. Some spellcheckers can help you write better style before even saving the text.
-
@bagder @shaman007 IMHO for technical documentation: simple is better. BTW. Some spellcheckers can help you write better style before even saving the text.
@bitnacht @shaman007 in a distributed world where everyone uses their own tools and editors we need the checks in CI anyway. Those are the rules that bind us all.
-
@bitnacht @shaman007 in a distributed world where everyone uses their own tools and editors we need the checks in CI anyway. Those are the rules that bind us all.
@bagder @shaman007 I just don‘t think this example will either increase your productivity nor help the people reading the paragraphs in question. But if it makes you happy: keep up the enthusiasm.
-
@bagder @shaman007 I just don‘t think this example will either increase your productivity nor help the people reading the paragraphs in question. But if it makes you happy: keep up the enthusiasm.
@bitnacht @shaman007 Writing coherent and good documentation is a huge task. Avoiding a single word is just a tiny little bit of that and will of course in itself not make much of a difference. But I am convinced using coherent, proper and easily read language helps users. So we try to do that.
-
a detail you probably didn't know: nowhere in any #curl documentation do we use the word "very". It is a banned word enforced by a CI check. This rule encourages us to rewrite and instead use more appropriate words. Makes us write better English.
and now I'm about to drop all uses of "just"... https://github.com/curl/curl/pull/20793
-
@bitnacht @shaman007 Writing coherent and good documentation is a huge task. Avoiding a single word is just a tiny little bit of that and will of course in itself not make much of a difference. But I am convinced using coherent, proper and easily read language helps users. So we try to do that.
@bagder @shaman007 100% agree. And it is true that if you are forced to go over a text for a second time, you are likely to find ways to make it clearer and more concise along the way. So I see your point now.
-
and now I'm about to drop all uses of "just"... https://github.com/curl/curl/pull/20793
@bagder I am forever rewriting my docs and commit messages to remove "just" and "simply".
-
and now I'm about to drop all uses of "just"... https://github.com/curl/curl/pull/20793
@bagder You missed the opportunity to title the PR
"Just don't do it" -
R relay@relay.infosec.exchange shared this topic
