Skip to content

Commit 5493ae9

Browse files
docs: shorten exampleStyle description for conciseness
Co-Authored-By: [email protected] <[email protected]>
1 parent 859e206 commit 5493ae9

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

fern/products/sdks/snippets/readme-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ readme:
5353
</ParamField>
5454

5555
<ParamField path="exampleStyle" type="'minimal' | 'comprehensive'" required={false} default="comprehensive" toc={true}>
56-
Controls the verbosity of usage examples in the generated README. Use `minimal` to show only required parameters with simplified examples, or `comprehensive` to show all parameters including optional ones. Minimal examples improve readability for APIs with many optional fields.
56+
Controls whether usage examples show only required parameters (`minimal`) or all parameters (`comprehensive`). Minimal examples improve readability for APIs with many optional fields.
5757
</ParamField>
5858

5959
<ParamField path="disabledSections" type="list of strings" required={false} toc={true}>

0 commit comments

Comments
 (0)