boto / boto3

99%

develop: 91%

LAST BUILD ON BRANCH docs-kwargs

branch: docs-kwargs

CHANGE BRANCH

x

Reset

• docs-kwargs
• 0.0.1
• 0.0.10
• 0.0.11
• 0.0.13
• 0.0.14
• 0.0.15
• 0.0.17
• 0.0.18
• 0.0.19
• 0.0.2
• 0.0.20
• 0.0.22
• 0.0.3
• 0.0.4
• 0.0.5
• 0.0.6
• 0.0.7
• 0.0.8
• 0.0.9
• 1.0.0
• 1.0.1
• 1.1.0
• 1.1.2
• 1.1.3
• batch-actions
• collection-path-fix
• collections
• collisions
• config-docs
• deps
• develop
• doc-example
• doc-structure
• docs
• docs-fix
• docs-refs
• equality
• error-info
• install-fix
• integ
• load-fix
• loader
• master
• meta-object
• migration-guide
• model
• model-collision
• model-update
• model-version-update
• plural-refs
• ref-load
• references
• region-config
• remove-six
• repr
• resource-model-update
• reverse-jmespath
• s3-high-level
• s3-ident-fix
• service-subresources
• threading-doc
• unique-meta
• useragent

Build # 160

Build Type

push

travis-ci

Committed by danielgtaylor

Commit Message

Update param documentation to be more explicit.

This pull request modifies the guide and generated reference documentation
to make it more obvious that operation parameters need to be passed as
keyword arguments rather than positional arguments. It does the following:

* Update the guide to explicitly call out that keyword arguments
  must be used instead of positional arguments.
* Update reference documentation for operations to:

  * List all arguments as keyword arguments (i.e. `MyArg=None`)
  * Show an example with all required arguments
  * Specify whether a parameter is optional or required after its type

Run Details

602 of 611 relevant lines covered (98.53%)

4.92 hits per line