Remove buggy start parameter from virt.pool_running docstring

As mentioned by issue #57275, the start parameter in virt.pool_running
documentation is not implemented at all. Remove it from the doc.
This commit is contained in:
Cédric Bosdonnat 2020-05-25 09:25:25 +02:00 committed by Daniel Wozniak
parent 95cd625473
commit f0b953b2fa
2 changed files with 1 additions and 2 deletions

1
changelog/57275.fixed Normal file
View file

@ -0,0 +1 @@
Remove buggy start parameter from virt.pool_running docstring

View file

@ -1345,8 +1345,6 @@ def pool_running(
when set to ``True``, the pool will be automatically undefined after being stopped. (Default: ``False``)
:param autostart:
Whether to start the pool when booting the host. (Default: ``True``)
:param start:
When ``True``, define and start the pool, otherwise the pool will be left stopped.
:param connection: libvirt connection URI, overriding defaults
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults