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 @see to improve self-documentation #16188

Merged
merged 1 commit into from
Apr 6, 2024

Conversation

hamirmahal
Copy link
Contributor

Description

Checklist

Try the playground for this PR

Copy link
Contributor Author

@hamirmahal hamirmahal left a comment

Choose a reason for hiding this comment

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

This change makes it so that when users copy and paste a default configuration, they'll automatically have a link to documentation with more detailed information.

@sosukesuzuki sosukesuzuki merged commit 6215520 into prettier:main Apr 6, 2024
28 checks passed
@hamirmahal hamirmahal deleted the patch-1 branch April 6, 2024 17:16
@hamirmahal
Copy link
Contributor Author

How long does it take for changes merged into main to be visible in production?

https://prettier.io/docs/en/configuration.html shows

// prettier.config.js, .prettierrc.js, prettier.config.cjs, or .prettierrc.cjs

/** @type {import("prettier").Config} */
const config = {
  trailingComma: "es5",
  tabWidth: 4,
  semi: false,
  singleQuote: true,
};

module.exports = config;

instead of

// prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs

/**
 * @see https://prettier.io/docs/en/configuration.html
 * @type {import("prettier").Config}
 */
const config = {
  trailingComma: "es5",
  tabWidth: 4,
  semi: false,
  singleQuote: true,
};
export default config;

@fisker
Copy link
Member

fisker commented May 19, 2024

To update the website, website/versioned_docs/version-stable/configuration.md should be updated, or wait for next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants