psf/black

Add more documentation about preview style features

AshSta512 opened this issue · 0 comments

Is this related to a problem? Please describe.

The descriptions of many preview style features aren't very descriptive as they only have one sentence explaining each of them in the docs.
This can lead to uncertainty about how some of the preview features affect formatting.
Contrasting this to the unstable style features that have dedicated sections and examples explaining what they do, I feel that the preview style features should receive the same treatment.

Describe the solution you'd like

Similar to the unstable style features, I would like to see a dedicated section for each preview style feature that includes a more descriptive explanation alongside one or more code examples.

The sections for each feature don't have to be long to avoid bloating the documentation, but I feel more than the single sentence description would help users to understand how the preview style affects their code.

Describe alternatives you've considered

An alternative to dedicated sections could be to simply add more clarity to the existing descriptions through offering a few sentences per feature and/or an example for the features that aren't as obvious.