Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove "please" #3571

Closed
jorgeorpinel opened this issue May 18, 2022 · 4 comments · Fixed by #4249
Closed

Remove "please" #3571

jorgeorpinel opened this issue May 18, 2022 · 4 comments · Fixed by #4249
Assignees
@casperdcl
Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.

Comments

@jorgeorpinel
Copy link
Contributor

On the opposite end of #1394

Should we remove and avoid "please" from all or parts of the docs? Reasons

  • It's unnecessary as long as our docs are already friendly
  • We don't currently use it consistently so the tone changes from page to page

Thoughs @iterative/docs ? May apply to other content as well.
@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions ❓ type: question Information is requested labels May 18, 2022
@casperdcl
Copy link
Contributor

casperdcl commented May 18, 2022 •
edited
Loading

IMO "please" is for blogs, not for docs. The only exception is genuine pleading:

  • "if it's broken please open an issue"
  • "please subscribe!"

But even then I'd rather avoid it. I always prefer conciseness, dropping unneeded words.

I view this as a duplicate of #1394, not the opposite.

@jorgeorpinel jorgeorpinel added help wanted Contributors especially welcome A: docs Area: user documentation (gatsby-theme-iterative) and removed ❓ type: question Information is requested labels May 18, 2022
@jorgeorpinel jorgeorpinel changed the title doc: remove "please" ? doc: remove "please" Aug 24, 2022
@BhaswatiRoy
Copy link
Contributor

Hello @jorgeorpinel
Do you mean removing "please" from these texts too?
We can also rephrase the sentences in such a way that they are friendly without the requirement of the "please" word
image
image
I can work on this!

@jorgeorpinel jorgeorpinel changed the title doc: remove "please" Pemove "please" Jan 15, 2023
@jorgeorpinel jorgeorpinel changed the title Pemove "please" Remove "please" Jan 15, 2023
@jorgeorpinel jorgeorpinel added p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. and removed type: enhancement Something is not clear, small updates, improvement suggestions labels Jan 15, 2023
@jorgeorpinel
Copy link
Contributor Author

Thanks for your interest @BhaswatiRoy . Yes we'd want to review every instance of "please" or similarly exaggerated friendly tone. Feel free to open a PR removing/changing the phrases you can find.

@BhaswatiRoy BhaswatiRoy mentioned this issue Jan 19, 2023
Merged
@BhaswatiRoy
Copy link
Contributor

Hello @jorgeorpinel
I have submitted the pr by rephrasing all sentences containing "please" in the docs section.

casperdcl added a commit that referenced this issue Jan 25, 2023
@BhaswatiRoy @omesser @casperdcl
Remove inappropriate "please", minor rewording (#4249)
cee6e6f 
Fixes #3571

Co-authored-by: Oded Messer <[email protected]>
Co-authored-by: Casper da Costa-Luis <[email protected]>
@casperdcl casperdcl self-assigned this Jan 25, 2023
@omesser omesser mentioned this issue Mar 3, 2023
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@casperdcl casperdcl

Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove inappropriate "please", minor rewording BhaswatiRoy/dvc.org
3 participants
@jorgeorpinel @casperdcl @BhaswatiRoy