libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nikolaos Kakouros (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (LIBCLOUD-927) Documentation is lacking for "network" argument in gce_create_route
Date Sat, 24 Jun 2017 21:06:00 GMT

     [ https://issues.apache.org/jira/browse/LIBCLOUD-927?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Nikolaos Kakouros updated LIBCLOUD-927:
---------------------------------------
    Description: 
_(This affects the latest version on github, I am not sure what is going on with versions
in Jira)_
Current documentation of 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.

  was:
_(This affects the latest version on github, I am not sure what is going on with versions
in Jira)_
Current documentation of ex_create_route() says:

{{        :param  network: The network the route belongs to. Can be either the
                         full URL of the network or a libcloud object.}}

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.


> Documentation is lacking for "network" argument in gce_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 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