Giter Club home page Giter Club logo

bcdoc's Introduction

bcdoc

Build Status

Tools to help document botocore-based projects

bcdoc's People

Contributors

garnaat avatar jamesls avatar kyleknap avatar toastdriven avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

bcdoc's Issues

Incorrect doc for boolean in a structure

For example, ec2 run instances's --monitoring we get a --no-enabled as part of the inner boolean type:

       --monitoring (structure)
              Enables monitoring for the instance.

              enabled  | --no-enabled  (boolean)

              JSON Parameter Syntax

              {
                "enabled": true|false
              }

Updates needed to bcdoc's PyPI record

https://github.com/boto/bcdoc/blob/develop/setup.py#L35 confirms Python3 support but the PyPI record (https://pypi.python.org/pypi/bcdoc) does not contain these trove classifiers.

Also the https://github.com/botocore/bcdoc should be changed to https://github.com/boto/bcdoc [removing 'core'] in both https://pypi.python.org/pypi/bcdoc and in setup.py. See pull request #29

For a full list of trove classifiers see: https://pypi.python.org/pypi?%3Aaction=list_classifiers

Not generating syntax examples for some blob params

I believe this is if a struct param has a single blob param you don't get any help, for example:

$ aws ses send-raw-email help
...
       --raw-message (structure)
              The  raw  text  of  the  message.  The client is responsible for
              ensuring the following:

       o Message must contain a header and a body, separated by a blank  line.

       o All required header fields must be present.

       o Each part of a multipart MIME message must be formatted properly.

       o MIME content types must be among those supported by Amazon SES. Refer
         to the Amazon SES Developer Guide for more details.

       o Content must be base64-encoded, if MIME requires it.

       data (blob)
         The raw data of the message. The client must ensure that the  message
         format  complies with Internet email standards regarding email header
         fields, MIME types, MIME encoding, and  base64  encoding  (if  neces-
         sary).

         For  more  information,  go  to  the`Amazon  SES  Developer  Guide <-
         http://docs.amazonwebservices.com/ses/latest/DeveloperGuide>`_ .

         JSON Parameter Syntax

         {

         }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.