Back to all reviewers

Write clear examples

boto/boto3
Based on 5 comments
Other

Create comprehensive code examples in documentation that demonstrate common operations and use proper formatting. Use double backticks (``) for inline code references in reStructuredText, and wrap code blocks in proper directives:

Documentation Other

Reviewer Prompt

Create comprehensive code examples in documentation that demonstrate common operations and use proper formatting. Use double backticks (``) for inline code references in reStructuredText, and wrap code blocks in proper directives:

.. code-block:: python

    import boto3
    
    # Create an S3 client
    s3 = boto3.client('s3')
    
    # Upload a file to S3 - this demonstrates the simple method for small files
    s3.upload_file('local/path/to/file', 'my-bucket', 'key/name.txt')

Always include explanatory comments that describe what each section accomplishes. For service-specific guides, include examples of frequently used operations like upload/download for S3. When documenting parameters or return values, use accurate descriptions that match the underlying implementation. Always generate and preview documentation before submission to ensure correct rendering.

5
Comments Analyzed
Other
Primary Language
Documentation
Category

Source Discussions