libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktdreyer <...@git.apache.org>
Subject [GitHub] libcloud pull request #1218: openstack: fix API doc for delete_floating_ip()
Date Fri, 22 Jun 2018 19:59:03 GMT
GitHub user ktdreyer opened a pull request:

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

    openstack: fix API doc for delete_floating_ip()

    ## openstack: fix API doc for delete_floating_ip()
    
    ### Description
    
    Prior to this change, Sphinx would not render the "ip" parameter type properly. You can
see this here: http://libcloud.readthedocs.io/en/latest/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.openstack.OpenStack_1_1_FloatingIpPool.delete_floating_ip
    
    Add a space so Sphinx will interpret the type properly.
    
    ### Status
    
    done, ready for review
    
    ### Checklist (tick everything that applies)
    
    - [ ] [Code linting](http://libcloud.readthedocs.org/en/latest/development.html#code-style-guide)
(required, can be done after the PR checks)
    - [ ] Documentation
    - [ ] [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/ktdreyer/libcloud openstack-del-float-ip-doc

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

    https://github.com/apache/libcloud/pull/1218.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 #1218
    
----
commit 9a443adc89e9a15f2c94a0914e12919c7df2ef7c
Author: Ken Dreyer <ktdreyer@...>
Date:   2018-06-22T19:55:08Z

    openstack: fix API doc for delete_floating_ip()
    
    Prior to this change, Sphinx would not render the "ip" parameter type
    properly.
    
    Add a space so Sphinx will interpret the type properly.

----


---

Mime
View raw message