[LIBCLOUD-927] Documentation is lacking for "network" argument in GCENodeDriver.ex_create_route

• Type: Improvement
• Status: Open
• Priority: Trivial
• Resolution: Unresolved
• Affects Version/s: 0.13.3
• Component/s: Documentation
• Labels: easyfix newbie

Environment

Irrelevant

• Assignee: Unassigned
• Reporter: Nikolaos Kakouros
• Created: 24/Jun/17 21:04
• Updated: 24/Jun/17 21:19

Description

(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:

        :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:

        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']

This option should be documented as well.

Issue Links

• links to: GitHub Pull Request #1081