Skip to content

Warn against Markdown links in Download component children - #6944

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-14-fern-ai-d8be69-d5ea635c
Open

fern-api[bot] wants to merge 1 commit into
mainfrom
2026-09-14-fern-ai-d8be69-d5ea635c

Conversation

@fern-api

@fern-api fern-api Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Expanded the children ParamField description on the Download component page to explicitly warn that wrapping the click target in a Markdown link (e.g. [Download PDF](./file.pdf)) is incorrect and unnecessary — <Download> handles the link behavior itself, so plain text or a <Button> element is all that's needed.


<ParamField path="children" type="React.ReactNode" required={true}>
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`.
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. Do not wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] <Microsoft.UIVerbs> reported by reviewdog 🐶
Use 'select' instead of the input-specific verb 'click'.


<ParamField path="children" type="React.ReactNode" required={true}>
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`.
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. Do not wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'Do not'.

Suggested change
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. Do not wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. don't wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.

@github-actions

Copy link
Copy Markdown
Contributor

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.

0 participants