Add documentation for Python configuration options #17
Conversation
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
Contributor
|
🌿 Preview your docs: https://fernv2-preview-796806ad-46a7-44e8-b0d7-7841f055949b.docs.buildwithfern.com |
dsinghvi
reviewed
Jul 3, 2025
| - name: fernapi/fern-python | ||
| version: 0.6.6 | ||
| config: | ||
| include_validators: true |
Member
There was a problem hiding this comment.
can you show can example of using the client.name property since that is the most used config!
Collaborator
Author
There was a problem hiding this comment.
yes! would that look like this?
config:
client:
filename: "my_custom_client.py"
class_name: "MyClient"
exported_filename: "my_client.py"
exported_class_name: "APIClient"
and actually, the subfields for the client option aren't documented on this page. something to add?
dsinghvi
reviewed
Jul 3, 2025
dsinghvi
approved these changes
Jul 3, 2025
Contributor
|
🌿 Preview your docs: https://fernv2-preview-28b45747-5360-414c-9473-0fe0217cd1c5.docs.buildwithfern.com |
dsinghvi
reviewed
Jul 3, 2025
| filename: my_custom_client.py | ||
| class_name: MyClient | ||
| exported_filename: my_client.py | ||
| exported_class_name: APIClient |
Member
There was a problem hiding this comment.
@devalog can you try
client:
class_name: `YourClient`
Contributor
|
🌿 Preview your docs: https://fernv2-preview-7cd7cbe4-f86d-453b-a6d5-2310e4b6ddc5.docs.buildwithfern.com |
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.
Fill out
configuration.mdxfile for the Python SDK based on this README (just the SDK Generator Configuration section) and the Python config classI didn't add
client_class_nameandclient_filenameto this file because they're marked as deprecated. I also thinkuse_typeddict_requests_for_file_uploadshould be removed based on its description but would like confirmation!One additional note –
skip_formattingdefaults to false per the config class, but readme says default is true. I putfalsein the file.