Removed condenscened language from settings #1396
Conversation
|
CI checks are failing @kurianbenoy please fix formatting as explained in https://dvc.org/doc/user-guide/contributing/docs. Contact me with questions or if you need help. |
content/blog/2017-08-23-ml-model-ensembling-with-fast-iterations.md
Outdated
Show resolved
Hide resolved
| - simply opening a file with your favorite editor and adding a dependency there | ||
| - opening a file with your favorite editor and adding a dependency there |
There was a problem hiding this comment.
I don't think this instance of "simply" counts as condescending. It just means that the operation is not complex. Opening a file is quite simple. Or am I wrong based on whatever source you used to decide these, @kurianbenoy? Please share if so. I could def. be wrong.
There was a problem hiding this comment.
@jorgeorpinel isn't simply just an adverb in this case, won't it be better to remove this in this context?
For someone who may not be a programmer, maybe opening a file is not quite simple after all. I personally got that impression after reading this article
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
There was a problem hiding this comment.
OK you may be right but I didn't really think we would change anything in the blogs, just the docs section of our website (https://dvc.org/doc)
Let's leave it for now but let @andronovhopf decide on this one. Can you chime in please Elle? Thanks
| analysis scripts. Simply run | ||
| analysis scripts. You can run the command: |
There was a problem hiding this comment.
Again I don't see "simply" as condescending here. You could just replace it with "Just" to be sure though, instead of adding several more words.
There was a problem hiding this comment.
Agreed, I feel let it be like that itself, because - just is also a condescending word instance
There was a problem hiding this comment.
I see you went for "You run" — doesn't sound very good. Please use "You can run" for now but this is also in the blog so let's see what @andronovhopf thinks.
|
@andronovhopf please just double check the few changes to blog articles. Thanks |
content/docs/api-reference/open.md
Outdated
| > If you just needed to load the complete file contents into memory, you can use | ||
| > If you want to load the complete file contents into memory, you can use |
There was a problem hiding this comment.
Again, not convinced this is condescending. What's the rationale?
There was a problem hiding this comment.
Do you agree with that the wording can be rewritten even more specifically with this change?
There was a problem hiding this comment.
I agree with you it's not condescending,
I feel instead of just needed, can't we use -> wanted
There was a problem hiding this comment.
Even though as the article as says:
If it's necessary, what is it trying to say?
With documentation, it's rare for terms like easy to be intentionally condescending. Often times, writers use them to show that something isn't as intimidating as it sounds. If this is the case, think about what the docs are trying to communicate and replace the condescending language with word choices that better represent the intention.
If you're struggling to find alternatives, Jim Fisher has some suggestions:
Be specific: Maybe it's easy because it's quick to set up, doesn't require much typing or has few moving parts.
Be comparative: Something is smaller than something else. Compared to another product, your product requires less custom configuration.
Be absolute: It takes 5 lines of code to integrate this library. There are two form fields required.
Show, don't tell: Instead of using time as an indicator for how easy something is, create a video.
There was a problem hiding this comment.
Thanks for the reference @kurianbenoy this makes sense cc @andronovhopf you may find this interesting as well 🙂
But in this case it's neither intentionally nor unintentionally condescending because it's in a conditional sentence so it has a completely different meaning: "if all you need to do is..." and this meaning should be preserved so please roll back or rewrite in the style I just used. Thanks
There was a problem hiding this comment.
Still pending to roll this one back please.
| > (just download the file or directory). | ||
| > (downloads the file or directory). |
There was a problem hiding this comment.
"Just" is also OK here: Not condescending but descriptive.
But that s was missing indeed, so pls change back to just downloads.
There was a problem hiding this comment.
Can we find a better word for just in this scenario?
Alex.js warning:
warning just may be insensitive, try not to use it just retext-equality
There was a problem hiding this comment.
What is Alex.js ?
warning just may be insensitive
It's not insensitive here. It means "downloads only" but sounds more natural. Please just roll it back 😋 (that one IS insensitive).
There was a problem hiding this comment.
@kurianbenoy I reviewed the first 10 files. Several good changes! But several others seem like they weren't considered carefully. Let's not just grep all instances of "simply", "just", etc. and remove them blindly. It depends on the context.
Please address these comments and try to also apply to all the remaining files I didn't review specifically yet. Then request my review again.
Co-authored-by: Jorge Orpinel <[email protected]>
|
@kurianbenoy before we do more changes - please, address @jorgeorpinel 's review and let's fix CI. |
|
I have addressed comments of @jorgeorpinel reviews, I have only made changes to the first 10 files reviewed. I will make more changes soon. |
| [pushshift.io](https://pushshift.io/), a database that contains basically all of | ||
| Reddit's content (so why make this dataset? I wanted to remove some of the | ||
| barriers to analyzing text from r/AmItheAsshole by providing an | ||
| already-processed and cleaned version of the data that can be downloaded with a | ||
| line of code; pushshift takes some work). You might use pushshift's API and/or | ||
| praw to augment this dataset in some way- perhaps to compare activity in this | ||
| subreddit with another, or broader patterns on Reddit. | ||
| [pushshift.io](https://pushshift.io/), a database that contains all of Reddit's |
There was a problem hiding this comment.
This one is also trying to say something important. I still don't see many of these words as condescending but maybe I'm still wrong. I would agree to replace "basically" here with something more specific (as explained in #1396 (comment)).
There was a problem hiding this comment.
Actually, let's roll this one back and not touch blog posts to make this easier. Blog posts have specific authors and the tone in their posts is up to them 🙂
This comment has been minimized.
This comment has been minimized.
|
Sorry, I was just busy with the DVC 1.0 release and couldn't get back to reviewing this. But it's still a valid PR. |
|
It's going to require lots of conflict solving though. @kurianbenoy do you want to resolve those conflicts or rather branch off master again and re-apply all of these changes? (and open a new PR, closing this one) |
|
@jorgeorpinel creating a new branch off master might be a better idea. I agree it's good time to close this PR and reopen as a new PR again |
|
Hi @kurianbenoy, Are you having issues resetting your fork's master branch and re-applying your changes? It would probably be a better idea not to use Feel free to reach out to me if you need help with Git. |
Fix #1394