-
Notifications
You must be signed in to change notification settings - Fork 206
SG-40841 Cleanup Python code examples in docs #421
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: master
Are you sure you want to change the base?
Conversation
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.
Pull Request Overview
This PR standardizes Python code examples in the documentation by switching from single quotes to double quotes for strings, improving dictionary and list formatting with consistent indentation and trailing commas, and removing obsolete sections.
- Converts all Python string literals from single quotes to double quotes throughout code examples
- Reformats code examples with proper indentation, line breaks, and trailing commas for better readability
- Removes deprecated
requirements.txtinstallation section from installation docs
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference.rst | Updates code examples to use double quotes and improved formatting; adds inline comments for clarity |
| docs/installation.rst | Removes deprecated requirements.txt section and applies quote standardization |
| docs/index.rst | Reformats quickstart example with double quotes and improved structure |
| docs/cookbook/usage_tips.rst | Standardizes quotes and formatting across all usage examples |
| docs/cookbook/tasks/updating_tasks.rst | Converts task update examples to use double quotes |
| docs/cookbook/tasks/task_dependencies.rst | Updates task dependency examples with consistent formatting |
| docs/cookbook/tasks/split_tasks.rst | Reformats split task examples for better readability |
| docs/cookbook/examples/svn_integration.rst | Modernizes SVN integration example with double quotes and improved formatting |
| docs/cookbook/examples/basic_update_shot.rst | Updates basic shot update example to use double quotes |
| docs/cookbook/examples/basic_sg_instance.rst | Converts instance creation example to double quotes |
| docs/cookbook/examples/basic_find_shot.rst | Standardizes find operation examples |
| docs/cookbook/examples/basic_delete_shot.rst | Updates delete examples with double quotes |
| docs/cookbook/examples/basic_create_version_link_shot.rst | Reformats version creation example with improved structure |
| docs/cookbook/examples/basic_create_shot.rst | Updates shot creation example formatting |
| docs/cookbook/examples/ami_version_packager.rst | Modernizes AMI packager example with double quotes and better formatting |
| docs/cookbook/examples/ami_handler.rst | Updates AMI handler example with consistent quote style |
| docs/cookbook/attachments.rst | Reformats attachment handling examples throughout |
| docs/authentication.rst | Updates authentication examples to use double quotes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
No description provided.