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

enable ruff rule: ambiguous-unicode-character-docstring (RUF002) #9184

Closed
RayBB opened this issue Apr 29, 2024 · 0 comments · Fixed by #9185
Closed

enable ruff rule: ambiguous-unicode-character-docstring (RUF002) #9184

RayBB opened this issue Apr 29, 2024 · 0 comments · Fixed by #9185
Labels
Lead: @scottbarnes Issues overseen by Scott (Community Imports) Needs: Triage This issue needs triage. The team needs to decide who should own it, what to do, by when. [managed] Type: Bug Something isn't working. [managed]

Comments

@RayBB
Copy link
Collaborator

RayBB commented Apr 29, 2024

Problem

This rule is enabled by default and we manually disabled it for some reason.

I don't think there is a good reason to have this disabled. We shouldn't have ambiguous characters in our docstrings unless absolutely needed (like the one example where we added an exception).

Evidence / Screenshot

Relevant URL(s)

https://docs.astral.sh/ruff/rules/ambiguous-unicode-character-docstring/#ambiguous-unicode-character-docstring-ruf002

Reproducing the bug

  1. Go to ...
  2. Do ...
  • Expected behavior:
  • Actual behavior:

Context

  • Browser (Chrome, Safari, Firefox, etc):
  • OS (Windows, Mac, etc):
  • Logged in (Y/N): Y
  • Environment (prod, dev, local): prod

Notes from this Issue's Lead

Proposal & constraints

Related files

Stakeholders

@RayBB RayBB added Type: Bug Something isn't working. [managed] Needs: Triage This issue needs triage. The team needs to decide who should own it, what to do, by when. [managed] Needs: Lead labels Apr 29, 2024
@RayBB RayBB changed the title enable ruff rule ambiguous-unicode-character-docstring (RUF002) enable ruff rule: ambiguous-unicode-character-docstring (RUF002) Apr 29, 2024
@mekarpeles mekarpeles added Lead: @scottbarnes Issues overseen by Scott (Community Imports) and removed Needs: Lead labels Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead: @scottbarnes Issues overseen by Scott (Community Imports) Needs: Triage This issue needs triage. The team needs to decide who should own it, what to do, by when. [managed] Type: Bug Something isn't working. [managed]
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants