-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs: Improvements on provider_codegen for type hints and multi-line yaml descriptions
#4033
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: thepetk <[email protected]>
Signed-off-by: thepetk <[email protected]>
|
Hi @thepetk! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
This pull request has merge conflicts that must be resolved before it can be merged. @thepetk please rebase it. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork |
ashwinb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is great thank you. so much better!
What does this PR do?
This PR improves type hint cleanup in auto-generated provider documentation by adding regex logic.
Issues Fixed:
list[strinstead oflist[str])<class 'bool'>,<class 'str'>instead ofbool,str|character.Changes:
.replace) with regex-based type cleaning to preserve the trailing bracket in case oflistanddict.|character for multi-line YAML descriptions.Test Plan
|character.Note to the reviewer(s)
This is my first contribution to your lovely repo! Initially I was going thourgh docs (wanted to use
remote::geminias provider) and realized the issue. I've read the CONTRIBUTING.md and decided to open the PR. Let me know if there's anything I did wrong and I'll update my PR!