SG-41115 Cleanup Python code examples in docs#421
Draft
julien-lang wants to merge 5 commits intomasterfrom
Draft
SG-41115 Cleanup Python code examples in docs#421julien-lang wants to merge 5 commits intomasterfrom
julien-lang wants to merge 5 commits intomasterfrom
Conversation
Contributor
There was a problem hiding this comment.
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 <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
The goal of this PR is to update all Python code example in the docs and make them easier to read.