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.

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

doc: a bit of polishing #224

Merged
merged 3 commits into from
Aug 30, 2023
Merged

Conversation

SimonVerhoeven
Copy link
Contributor

What's changed?

Reworded things a little bit

What's your motivation?

Anything in particular you'd like reviewers to focus on?

Anyone you would like to review specifically?

Have you considered any alternatives or workarounds?

Any additional context

Checklist

  • I've added unit tests to cover both positive and negative cases
  • I've added the license header to any new files through ./gradlew licenseFormat
  • I've used the IntelliJ IDEA auto-formatter on affected files
  • I've updated the documentation (if applicable)


// TODO: Return if the varDec is an instance or class variable

// TODO: If none of the above apply, find all use cases for the variables and determine whether or not they're reassigned. If none have been, add the final modifier. If one ore more has, do nothing.
// TODO: If none of the above apply, find all use cases for the variables and determine whether or not they're reassigned. If none have been, add the final modifier. If one or more has, do nothing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting typo. Sadly ore is a word, but ^ore$ could be added to https://github.com/openrewrite/rewrite-docs/blob/master/.github/actions/spelling/reject.txt if it's unlikely to be appropriate in this repository :)

@jsoref
Copy link
Contributor

jsoref commented Aug 29, 2023

@SimonVerhoeven: sorry, I didn't mean that. You were correct that ore is a typo here.

In fact it's reliably a typo in any construct of the form ore more:

https://grep.app/search?current=10&q=%28.%5B%5Ee%5D%7C%5B%5En%5De%29%20ore%20more&regexp=true&case=true
https://grep.app/search?q=%20ore%20more&case=true&words=true

Your caught typo was so good that I've added a rule for it:
check-spelling/spell-check-this@b34617c

What I was trying to say is that if this project will never use ore, it could reject it to prevent it from sneaking in going forward.

@SimonVerhoeven
Copy link
Contributor Author

Ahah, sorry. I've updated it.

@timtebeek timtebeek requested a review from mike-solomon August 30, 2023 06:52
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Aug 30, 2023
Copy link
Contributor

@mike-solomon mike-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me. Thanks so much for making these changes and helping others by improving the docs!

@mike-solomon mike-solomon merged commit 81f1468 into openrewrite:master Aug 30, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants