Warn against Markdown links in Download component children - #6944
Open
fern-api[bot] wants to merge 1 commit into
Open
fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
fern-api
Bot
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 14, 2026 13:03
|
|
||
| <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. |
Contributor
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
🚫 [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. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-14-fern-ai-d8be69-d5ea635c.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expanded the
childrenParamField 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.