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

D207 and D300 doesn't mention formatter redundancy #9675

Closed
trag1c opened this issue Jan 29, 2024 · 4 comments · Fixed by #10007
Closed

D207 and D300 doesn't mention formatter redundancy #9675

trag1c opened this issue Jan 29, 2024 · 4 comments · Fixed by #10007
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@trag1c
Copy link
Contributor

trag1c commented Jan 29, 2024 •
edited
Loading

Both D207 and D208 seem to be affected by the formatter, yet only D208 documents that behavior. Are there any cases in which D208 violations won't get formatted correctly or is this just an oversight?
@zanieb
Copy link
Member

zanieb commented Jan 29, 2024 •
edited
Loading

It looks like an oversight to me; thanks!

@zanieb zanieb added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 29, 2024
@trag1c
Copy link
Contributor Author

trag1c commented Jan 29, 2024

Looks like it also applies to D300.

@trag1c trag1c changed the title D207 doesn't mention formatter redundancy D207 and D300 doesn't mention formatter redundancy Jan 29, 2024
@takaya0
Copy link
Contributor

takaya0 commented Feb 1, 2024

I'd like to try this issue. Could you assign me to fix this issue?

arkuhn added a commit to arkuhn/ruff that referenced this issue Feb 16, 2024
@arkuhn
docs: Formatter compatability warning for D207 and D300
6c8c321 
- Update docs to mention formatter compatability interactions for
under-indentation (D207) and triple-single-quotes (D300)
- Changes verified locally with mkdocs
- Closes: astral-sh#9675
arkuhn added a commit to arkuhn/ruff that referenced this issue Feb 16, 2024
@arkuhn
docs: Formatter compatibility warning for D207 and D300
dcb260e 
- Update docs to mention formatter compatability interactions for
under-indentation (D207) and triple-single-quotes (D300)
- Changes verified locally with mkdocs
- Closes: astral-sh#9675
@arkuhn arkuhn mentioned this issue Feb 16, 2024
Merged
charliermarsh pushed a commit that referenced this issue Feb 17, 2024
@arkuhn
docs: Formatter compatibility warning for D207 and D300 (#10007)
d46c5d8 
- Update docs to mention formatter compatibility interactions for
under-indentation (D207) and triple-single-quotes (D300)
- Changes verified locally with mkdocs
- Closes: #9675
nkxxll pushed a commit to nkxxll/ruff that referenced this issue Mar 10, 2024
@arkuhn @nkxxll
docs: Formatter compatibility warning for D207 and D300 (astral-sh#10007
abf31bc 
)

- Update docs to mention formatter compatibility interactions for
under-indentation (D207) and triple-single-quotes (D300)
- Changes verified locally with mkdocs
- Closes: astral-sh#9675
@Avasam
Copy link
Contributor

Avasam commented Dec 28, 2024 •
edited
Loading

Are you sure D300 applies? The playground even with preview=true does not format those docstring back to triple-quoting: https://play.ruff.rs/c41e8485-df53-4dbd-a738-274ffc71c6fe?secondary=Format

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Formatter compatibility warning for D207 and D300 arkuhn/ruff
4 participants
@Avasam @zanieb @takaya0 @trag1c