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

Fix ruff-action documentation to consistently use args instead of options #10249

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

MichaReiser
Copy link
Member

Summary

Fixes #10246

I also fixed the args in the example to include check because setting args replaces the default check args.

@@ -2,14 +2,16 @@

## VS Code (Official)

Download the [Ruff VS Code extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff),
Download
the [Ruff VS Code extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff),
Copy link
Member

Choose a reason for hiding this comment

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

Is this the IntelliJ thing where it bumps the word before the link to the next line for unknown reasons?

Copy link
Member

Choose a reason for hiding this comment

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

Can we revert the formatting changes?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh why did it do this. I disabled markdown formatting more than once because it's supper intrusive. Sorry for that

@MichaReiser MichaReiser force-pushed the ruff-action-example branch from 26d70cc to 0135907 Compare March 6, 2024 16:29
@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label Mar 6, 2024
Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

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

Thanks!

@MichaReiser MichaReiser merged commit fe6afbe into main Mar 6, 2024
16 checks passed
@MichaReiser MichaReiser deleted the ruff-action-example branch March 6, 2024 17:09
nkxxll pushed a commit to nkxxll/ruff that referenced this pull request Mar 10, 2024
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
None yet
Development

Successfully merging this pull request may close these issues.

Github action documentation refers to 'options' instead of 'args'
2 participants