René's URL Explorer Experiment


Title: Doc generation improvements by SamRemis · Pull Request #2 · SamRemis/smithy-python · GitHub

Open Graph Title: Doc generation improvements by SamRemis · Pull Request #2 · SamRemis/smithy-python

X Title: Doc generation improvements by SamRemis · Pull Request #2 · SamRemis/smithy-python

Description: This PR migrates from a string builder to using the smithy SimpleCodeWriter class. This both streamlines the code and fixes a number of doc rendering issues

Open Graph Description: This PR migrates from a string builder to using the smithy SimpleCodeWriter class. This both streamlines the code and fixes a number of doc rendering issues

X Description: This PR migrates from a string builder to using the smithy SimpleCodeWriter class. This both streamlines the code and fixes a number of doc rendering issues

Opengraph URL: https://github.com/SamRemis/smithy-python/pull/2

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:e1d3aa0b-9d92-7978-1078-4d6564567683
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idD7C8:1FFEE4:B5BFB8:1015F8D:6AFB5ADB
html-safe-nonce087c2b8804bb074de4a4854eb1c30c1dfaa60c16ec41c79729dd18f79a9fed70
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0M4OjFGRkVFNDpCNUJGQjg6MTAxNUY4RDo2QUZCNUFEQiIsInZpc2l0b3JfaWQiOiI4MzY2NDg3ODU5MzYzNTM1NTc5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacd1448d8478d845bb84f0f6e66a7df9cb87cd26cfbbd483958fa59d1b3d6f98b5
hovercard-subject-tagpull_request:2410066014
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/SamRemis/smithy-python/pull/2/files
twitter:imagehttps://avatars.githubusercontent.com/u/5881835?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/5881835?s=400&v=4
og:image:altThis PR migrates from a string builder to using the smithy SimpleCodeWriter class. This both streamlines the code and fixes a number of doc rendering issues
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noneea33d13c96d0ff66bd8fa906b193d2213536b78cb06b0c50a4632c58b1418f94
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/SamRemis/smithy-python git https://github.com/SamRemis/smithy-python.git
octolytics-dimension-user_id5881835
octolytics-dimension-user_loginSamRemis
octolytics-dimension-repository_id927927875
octolytics-dimension-repository_nwoSamRemis/smithy-python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forktrue
octolytics-dimension-repository_parent_id342067205
octolytics-dimension-repository_parent_nwosmithy-lang/smithy-python
octolytics-dimension-repository_network_root_id342067205
octolytics-dimension-repository_network_root_nwosmithy-lang/smithy-python
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release59ef97164c52cf59bd10558ddec9c4f482763988
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/SamRemis/smithy-python/pull/2/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FSamRemis%2Fsmithy-python%2Fpull%2F2%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FSamRemis%2Fsmithy-python%2Fpull%2F2%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=SamRemis%2Fsmithy-python
Reloadhttps://github.com/SamRemis/smithy-python/pull/2/files
Reloadhttps://github.com/SamRemis/smithy-python/pull/2/files
Reloadhttps://github.com/SamRemis/smithy-python/pull/2/files
SamRemishttps://github.com/SamRemis
smithy-pythonhttps://github.com/SamRemis/smithy-python
Codehttps://github.com/SamRemis/smithy-python
Pull requests12 (12)https://github.com/SamRemis/smithy-python/pulls
Actionshttps://github.com/SamRemis/smithy-python/actions
Projectshttps://github.com/SamRemis/smithy-python/projects
Security and qualityhttps://github.com/SamRemis/smithy-python/security
Insightshttps://github.com/SamRemis/smithy-python/pulse
Sign up for GitHub https://github.com/signup?return_to=%2FSamRemis%2Fsmithy-python%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2FSamRemis%2Fsmithy-python%2Fissues%2Fnew%2Fchoose
SamRemishttps://github.com/SamRemis
develophttps://github.com/SamRemis/smithy-python/tree/develop
docs-generation-updateshttps://github.com/SamRemis/smithy-python/tree/docs-generation-updates
Conversation 0 https://github.com/SamRemis/smithy-python/pull/2
Commits 3 https://github.com/SamRemis/smithy-python/pull/2/commits
Checks 0 https://github.com/SamRemis/smithy-python/pull/2/checks
Files changed https://github.com/SamRemis/smithy-python/pull/2/files
Please reload this pagehttps://github.com/SamRemis/smithy-python/pull/2/files
Doc generation improvements https://github.com/SamRemis/smithy-python/pull/2/files#top
Show all changes 3 commits https://github.com/SamRemis/smithy-python/pull/2/files
93d5abc Docs generation updates SamRemis Mar 21, 2025 https://github.com/SamRemis/smithy-python/pull/2/commits/93d5abcc9b3cfa7da24a345bd6b00232a01621fc
66ef5ac linter fix, add TODOs SamRemis Mar 21, 2025 https://github.com/SamRemis/smithy-python/pull/2/commits/66ef5accba641fc2a079e2278565558d4841e940
9d1e20a Add required trait to docs when relevant SamRemis Mar 26, 2025 https://github.com/SamRemis/smithy-python/pull/2/commits/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81
Clear filters https://github.com/SamRemis/smithy-python/pull/2/files
Please reload this pagehttps://github.com/SamRemis/smithy-python/pull/2/files
Please reload this pagehttps://github.com/SamRemis/smithy-python/pull/2/files
MarkdownToRstDocConverterTest.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-5d9bd1483073b9ede1b39e8cb10d1fe58920fb46944a8720603ccf546cef3bdd
ClientGenerator.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
SetupGenerator.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-17a458f9922951c70a90e39ffd3f11a4ec7db2e8e64ac7accd09fd14653d0922
StructureGenerator.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
MarkdownToRstDocConverter.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
PythonWriter.java https://github.com/SamRemis/smithy-python/pull/2/files#diff-3912ddcd97940cc6d33ebe4624059867329f79833f70c90d4e773d15502dab87
...rc/test/java/software/amazon/smithy/python/aws/codegen/MarkdownToRstDocConverterTest.javahttps://github.com/SamRemis/smithy-python/pull/2/files#diff-5d9bd1483073b9ede1b39e8cb10d1fe58920fb46944a8720603ccf546cef3bdd
View file https://github.com/SamRemis/smithy-python/blob/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81/codegen/aws/core/src/test/java/software/amazon/smithy/python/aws/codegen/MarkdownToRstDocConverterTest.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/SamRemis/smithy-python/pull/2/{{ revealButtonHref }}
https://github.com/SamRemis/smithy-python/pull/2/files#diff-5d9bd1483073b9ede1b39e8cb10d1fe58920fb46944a8720603ccf546cef3bdd
codegen/core/src/main/java/software/amazon/smithy/python/codegen/ClientGenerator.javahttps://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
View file https://github.com/SamRemis/smithy-python/blob/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81/codegen/core/src/main/java/software/amazon/smithy/python/codegen/ClientGenerator.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/SamRemis/smithy-python/pull/2/{{ revealButtonHref }}
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
https://github.com/SamRemis/smithy-python/pull/2/files#diff-d58106cf996ced9dfd5e790c5a28f8f961fc69178b3ac56e7e689e9f171014f1
...n/core/src/main/java/software/amazon/smithy/python/codegen/generators/SetupGenerator.javahttps://github.com/SamRemis/smithy-python/pull/2/files#diff-17a458f9922951c70a90e39ffd3f11a4ec7db2e8e64ac7accd09fd14653d0922
View file https://github.com/SamRemis/smithy-python/blob/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/SetupGenerator.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/SamRemis/smithy-python/pull/2/{{ revealButtonHref }}
https://github.com/SamRemis/smithy-python/pull/2/files#diff-17a458f9922951c70a90e39ffd3f11a4ec7db2e8e64ac7accd09fd14653d0922
https://github.com/SamRemis/smithy-python/pull/2/files#diff-17a458f9922951c70a90e39ffd3f11a4ec7db2e8e64ac7accd09fd14653d0922
...re/src/main/java/software/amazon/smithy/python/codegen/generators/StructureGenerator.javahttps://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
View file https://github.com/SamRemis/smithy-python/blob/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81/codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/StructureGenerator.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/SamRemis/smithy-python/pull/2/{{ revealButtonHref }}
https://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
https://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
https://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
https://github.com/SamRemis/smithy-python/pull/2/files#diff-628338bb48c258b0005ea5217f1979e3b6a7875912cf99c631c86d86f011d640
...src/main/java/software/amazon/smithy/python/codegen/writer/MarkdownToRstDocConverter.javahttps://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
View file https://github.com/SamRemis/smithy-python/blob/9d1e20af2b2e9ebb0aa81912ede4c7e1e8fdfb81/codegen/core/src/main/java/software/amazon/smithy/python/codegen/writer/MarkdownToRstDocConverter.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/SamRemis/smithy-python/pull/2/{{ revealButtonHref }}
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
https://github.com/SamRemis/smithy-python/pull/2/files#diff-baf5607ac48928c433cdb7483ee6070467a99e43ab836a1287f9faf9e5d91412
Please reload this pagehttps://github.com/SamRemis/smithy-python/pull/2/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.