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

Document lint.preview and format.preview #8032

Merged
merged 6 commits into from
Oct 18, 2023

Conversation

MichaReiser
Copy link
Member

Summary

The documentation for #8002. I separated it to a separate PR to unblock landing the code changes but still get the documentation reviewed.

@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label Oct 18, 2023
docs/preview.md Outdated Show resolved Hide resolved
Base automatically changed from lint-preview-option to main October 18, 2023 01:26
docs/preview.md Outdated Show resolved Hide resolved
docs/preview.md Outdated Show resolved Hide resolved
MichaReiser and others added 4 commits October 18, 2023 15:27
Add a new `lint.preview` option that configures the preview mode for the linter only.
Co-authored-by: Zanie Blue <contact@zanie.dev>
Co-authored-by: Zanie Blue <contact@zanie.dev>
@MichaReiser MichaReiser force-pushed the tool-specific-preview-documentation branch from bbeabda to 61c6462 Compare October 18, 2023 06:27
docs/preview.md Outdated Show resolved Hide resolved
Copy link
Member

@konstin konstin left a comment

Choose a reason for hiding this comment

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

Do we want to say that the formatter preview mode aims to mirror black preview mode?

Co-authored-by: Zanie Blue <contact@zanie.dev>
@MichaReiser
Copy link
Member Author

Do we want to say that the formatter preview mode aims to mirror black preview mode?

I would prefer a dedicated section that lists all preview style changes with an example, similar to what black has.

@MichaReiser MichaReiser enabled auto-merge (squash) October 18, 2023 23:21
@MichaReiser MichaReiser merged commit 46d5db5 into main Oct 18, 2023
15 checks passed
@MichaReiser MichaReiser deleted the tool-specific-preview-documentation branch October 18, 2023 23:30
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.

3 participants