Skip to content

Conversation

@julien-lang
Copy link
Member

@julien-langjulien-lang commented Oct 27, 2025

The goal of this PR is to update all Python code example in the docs and make them easier to read.

Copy link
Contributor

CopilotAI left a 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.txt installation 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
FileDescription
docs/reference.rstUpdates code examples to use double quotes and improved formatting; adds inline comments for clarity
docs/installation.rstRemoves deprecated requirements.txt section and applies quote standardization
docs/index.rstReformats quickstart example with double quotes and improved structure
docs/cookbook/usage_tips.rstStandardizes quotes and formatting across all usage examples
docs/cookbook/tasks/updating_tasks.rstConverts task update examples to use double quotes
docs/cookbook/tasks/task_dependencies.rstUpdates task dependency examples with consistent formatting
docs/cookbook/tasks/split_tasks.rstReformats split task examples for better readability
docs/cookbook/examples/svn_integration.rstModernizes SVN integration example with double quotes and improved formatting
docs/cookbook/examples/basic_update_shot.rstUpdates basic shot update example to use double quotes
docs/cookbook/examples/basic_sg_instance.rstConverts instance creation example to double quotes
docs/cookbook/examples/basic_find_shot.rstStandardizes find operation examples
docs/cookbook/examples/basic_delete_shot.rstUpdates delete examples with double quotes
docs/cookbook/examples/basic_create_version_link_shot.rstReformats version creation example with improved structure
docs/cookbook/examples/basic_create_shot.rstUpdates shot creation example formatting
docs/cookbook/examples/ami_version_packager.rstModernizes AMI packager example with double quotes and better formatting
docs/cookbook/examples/ami_handler.rstUpdates AMI handler example with consistent quote style
docs/cookbook/attachments.rstReformats attachment handling examples throughout
docs/authentication.rstUpdates authentication examples to use double quotes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

julien-langand others added 2 commits October 27, 2025 13:51
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@julien-langjulien-lang changed the title SG-40841 Cleanup Python code examples in docsCleanup Python code examples in docsNov 12, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@julien-lang