libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LIBCLOUD-927) Documentation is lacking for "network" argument in GCENodeDriver.ex_create_route
Date Sat, 24 Jun 2017 21:20:01 GMT

    [ https://issues.apache.org/jira/browse/LIBCLOUD-927?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16062139#comment-16062139
] 

ASF GitHub Bot commented on LIBCLOUD-927:
-----------------------------------------

GitHub user tterranigma opened a pull request:

    https://github.com/apache/libcloud/pull/1081

    [LIBCLOUD-927] Adds missing option to GCENodeDriver.ex_create_route() documentation

    ## Adds missing option in the documentation for GCENodeDriver.ex_create_route()
    
    ### Description
    Nothing fancy, just one more line of documentation. 
    
    ### Status
    - done, ready for review
    
    ### Checklist (tick everything that applies)
    
    - [x] [Code linting](http://libcloud.readthedocs.org/en/latest/development.html#code-style-guide)
(required, can be done after the PR checks)
    - [x] Documentation
    - [x] [Tests](http://libcloud.readthedocs.org/en/latest/testing.html)
    - [ ] [ICLA](http://libcloud.readthedocs.org/en/latest/development.html#contributing-bigger-changes)
(required for bigger changes)


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/tterranigma/libcloud LIBCLOUD-927_update-ex_create_route_docs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/libcloud/pull/1081.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1081
    
----
commit 45fe32c5014cb77d394524f97f11b5aff67f4754
Author: Nikolaos Kakouros <nkak@kth.se>
Date:   2017-06-24T21:14:15Z

    [LIBCLOUD-927] Adds missing option to GCENodeDriver.ex_create_route() documentation

----


> Documentation is lacking for "network" argument in GCENodeDriver.ex_create_route
> --------------------------------------------------------------------------------
>
>                 Key: LIBCLOUD-927
>                 URL: https://issues.apache.org/jira/browse/LIBCLOUD-927
>             Project: Libcloud
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.13.3
>         Environment: Irrelevant
>            Reporter: Nikolaos Kakouros
>            Priority: Trivial
>              Labels: easyfix, newbie
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> _(This affects the latest version on github, I am not sure what is going on with versions
in Jira)_
> Current documentation of GCENodeDriver.ex_create_route() says:
> {noformat}
>         :param  network: The network the route belongs to. Can be either the
>                          full URL of the network or a libcloud object.
> {noformat}
> However, from the relevant code in function it is obvious that a network name is also
valid:
> {code:python}
>         if isinstance(network, str) and network.startswith('https://'):
>             network_uri = network
>         elif isinstance(network, str):
>             network = self.ex_get_network(network)
>             network_uri = network.extra['selfLink']
>         else:
> network_uri = network.extra['selfLink']
> {code}
> This option should be documented as well.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message