Skip to content

[POC][WIP] Be kind to Newcomers #12228

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
Closed
wants to merge 1 commit into from
Closed

[POC][WIP] Be kind to Newcomers #12228

wants to merge 1 commit into from

Conversation

OskarStark
Copy link
Contributor

@OskarStark OskarStark commented Aug 22, 2019 •
edited
Loading

DON'T MERGE ❗️

@OskarStark
Copy link
Contributor Author

@lsmith77 do you think we should keep reporting the word "just" ? 🤔

@lsmith77
Copy link
Contributor

I think we should. IMHO its a fill word and can (almost?) always be simply deleted

@javiereguiluz
Copy link
Member

Of the proposed words, I agree that these are always bad for docs:

  • basic
  • easily
  • easy
  • logically
  • merely
  • obvious
  • of course
  • simply
  • trivial

I'm not sure about these (because there are some reasonable uses):

  • just

And I think we should not ban these words (because most of the times they are OK):

  • clear
  • quick

@OskarStark
Copy link
Contributor Author

That’s my feeling too @javiereguiluz.

@lsmith77
Copy link
Contributor

I agree .. however it would be nice to have two modes .. auto and manual. for auto we remove those words but we keep them for manual and we run manual now and then to find those edge cases.

This was referenced Sep 24, 2019
Merged
Merged
@javiereguiluz
Copy link
Member

I'm closing this as as fixed because the list of words is being updated in OskarStark/doctor-rst#285 and the only remaining error reported in this pull request is being fixed in #12361. Thanks Oskar.

javiereguiluz added a commit that referenced this pull request Sep 24, 2019
@javiereguiluz
minor #12361 [Cache] Reword a phrase to remove the "basic" word (javi…
20fff81 
…ereguiluz)

This PR was merged into the 3.4 branch.

Discussion
----------

[Cache] Reword a phrase to remove the "basic" word

This fixes the error reported in #12228.

Commits
-------

7d70ce7 [Cache] Rewrod a phrase to remove the "basic" word
@OskarStark OskarStark deleted the belittling-words branch December 7, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Status: Needs Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@OskarStark @lsmith77 @javiereguiluz @carsonbot