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

docs: add docs for editorconfig to configuration and options #11883

Merged
merged 1 commit into from Nov 30, 2021

Conversation

midgleyc
Copy link
Contributor

Description

Add documentation for editorconfig to the "options" and "configuration" sections.

#2760 initially added a paragraph to configuration, but this was reverted in #3213, and the reintroduction in #3255 only added to the "API" and "CLI" sections.

This change copies the paragraph from API's resolveConfig to the bottom of "configuration", and adds sentences to the relevant parts of "options" to increase discoverability of this feature.

Fixes #8044.

Checklist

  • I’ve added tests to confirm my change works.
  • (If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory).
  • (If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
  • I’ve read the contributing guidelines.

Try the playground for this PR

@duailibe duailibe merged commit 2160e11 into prettier:main Nov 30, 2021
@midgleyc midgleyc deleted the document-editorconfig branch November 30, 2021 19:25
@fisker
Copy link
Sponsor Member

fisker commented Dec 1, 2021

@sosukesuzuki I guess we are going to make a patch release soon? If not, we may want copy these lines to the website.

@sosukesuzuki
Copy link
Member

@fisker I will release new patch version soon. (for #11892)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EditorConfig support needs to be documented better
4 participants