Skip to content

Commit 309855d

Browse files
committed
fill out ruby config options
1 parent ea290f1 commit 309855d

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

fern/products/sdks/overview/ruby/configuration.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,20 @@ groups:
1919
## SDK Configuration Options
2020
2121
<ParamField path="clientClassName" type="string" required={false} toc={true}>
22+
The name of the generated client class. This allows you to customize the class name that users will instantiate when using your SDK.
2223
</ParamField>
23-
2424
<ParamField path="defaultTimeoutInSeconds" type="number | 'infinity'" required={false} toc={true}>
25+
The default timeout for network requests in seconds. In the generated client, this can be overridden at the request level. Set to 'infinity' to disable timeouts.
2526
</ParamField>
26-
2727
<ParamField path="extraDependencies" type="ExtraDependenciesSchema" required={false} toc={true}>
28+
Specify additional dependencies to include in the generated SDK's gemspec. This is useful when you need to add custom gems that your SDK depends on.
2829
</ParamField>
29-
3030
<ParamField path="extraDevDependencies" type="ExtraDependenciesSchema" required={false} toc={true}>
31+
Specify additional development dependencies to include in the generated SDK's gemspec. These are dependencies used for development and testing but not required by end users.
3132
</ParamField>
32-
3333
<ParamField path="flattenModuleStructure" type="boolean" default="false" required={false} toc={true}>
34+
When enabled, flattens the module structure of the generated SDK. This creates a simpler namespace hierarchy by reducing nested modules.
3435
</ParamField>
35-
3636
<ParamField path="useProvidedDefaults" type="boolean" required={false} toc={true}>
37+
When enabled, the SDK will use default values specified in your API definition. This allows you to leverage defaults defined in your Fern specification within the generated Ruby client.
3738
</ParamField>

0 commit comments

Comments
 (0)