Fix Python SDK configuration key from package-name to package_name #1280
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
The Python SDK configuration uses underscores, not hyphens. Updated: - configuration.mdx: Fixed package-name to package_name in example and ParamField paths - publishing-to-pypi.mdx: Fixed package-name to package_name in all YAML examples Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
- Updated readme-options.mdx to reference package_name (underscore) in config section - Reverted publishing-to-pypi.mdx output sections back to package-name (hyphen) - The output section uses package-name (hyphen) while config section uses package_name (underscore) Co-Authored-By: [email protected] <[email protected]>
Contributor
tjb9dc
approved these changes
Oct 16, 2025
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.
Fix Python SDK configuration key from package-name to package_name
Summary
Updated Python SDK documentation to use the correct configuration key
package_name(with underscore) in theconfigsection instead of the incorrectpackage-name(with hyphen). This fix addresses a documentation bug reported in #sdk-dev.Key distinction preserved:
output.package-name(hyphen) - remains unchanged, used for PyPI publishing locationconfig.package_name(underscore) - fixed in this PR, used for the actual Python package configurationFiles changed:
fern/products/sdks/overview/python/configuration.mdx- Updated 4 instances in theconfigsection YAML example and ParamField definitionsfern/products/sdks/snippets/readme-options.mdx- Fixed anchor link to reference the correctedpackage_namefieldReview & Testing Checklist for Human
config.package_name(underscore) and notconfig.package-name(hyphen) by testing with a real configuration or checking the generator source codeoutput.package-name(hyphen) is still the correct format for PyPI publishing - I kept it as hyphen based on generators-yml-reference.mdx, but this should be verified#package_nameanchor link works correctly from readme-options.mdxpackage-namein the context of theconfigsection that I may have missedNotes
output.package-nametooutput.package_namebecause the generators-yml-reference.mdx shows PyPI output usingpackage-namewith hyphenoutput(hyphen) andconfig(underscore) sections could be confusing for users - consider adding a note to clarify this if confirmed correct