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

When and which preview styles will be promoted to stable? #3989

Closed
konstin opened this issue Oct 27, 2023 · 4 comments
Closed

When and which preview styles will be promoted to stable? #3989

konstin opened this issue Oct 27, 2023 · 4 comments
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@konstin
Copy link
Contributor

konstin commented Oct 27, 2023

Hi! I'm working on the ruff formatter, a fast black compatible formatter.

There are a lot of impactful style improvements that are currently in preview style, which we are working to support, currently also gated behind a --preview flag. Do you already have a rough date in mind when you want to promote the preview style to stable, and do you know if you'll promote all rules or keep some of them in preview for another year (e.g. the new string wrapping)? I'm asking because we'd love stay compatible with black stable style and it'd be super helpful to have a rough timeline what we need to support.

@konstin konstin added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Oct 27, 2023
@JelleZijlstra
Copy link
Collaborator

This is documented at https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy. In short, the intention is that preview style features get promoted to stable once a year in our January release.

I expect to use a similar procedure this year as last:

  • In late November/early December, open an issue with a list of all preview features and a tentative decision on whether to include them
  • Release a 24.1a1 that implements the proposed new stable style
  • Publicize it to get feedback
  • In January, release 24.1.0 with the new stable style for 2024

Last year I feel we may not have gotten enough feedback during this period, leading to some controversy over certain decisions, so I hope we'll be able to get more early feedback this year. If Ruff or its users could provide feedback on any preview-style features, I'd be happy.

I don't know yet which preview style features will be made stable. The general hope is that all of them will be moved, but I'm not sure about the string formatting change, which may end up making too many controversial changes in formatting.

@konstin
Copy link
Contributor Author

konstin commented Oct 27, 2023

Thanks, that timeline is very helpful!

@hauntsaninja
Copy link
Collaborator

See now #4042 :-)

@konstin
Copy link
Contributor Author

konstin commented Nov 14, 2023

Thank you for the comprehensive list! I started tracking ruff's progress on this in astral-sh/ruff#8678

@konstin konstin closed this as completed Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

No branches or pull requests

3 participants