Commit 9fa6fd4e authored by David Johnson's avatar David Johnson

Fix some sphinx warnings; others seem unfixable!

I am powerless.
parent f13a48ca
......@@ -13,9 +13,10 @@ You can find this interface in a client-side dynslice library, at
https://gitlab.flux.utah.edu/elasticslice/elasticslice/ (specifically,
the file containing this class is
https://gitlab.flux.utah.edu/elasticslice/elasticslice/blob/master/elasticslice/managers/core.py).
Here is the interface::
class ElasticSliceClientEndpoint(ProtoGeniClientServerEndpoint):
class ElasticSliceClientEndpoint(ProtoGeniClientServerEndpoint):
"""
Creates a stub elasticslice client-server API endpoint that simply
returns SUCCESS (and prints out the RPC arguments on invocation if
......
......@@ -15,7 +15,7 @@ elasticslice.util.util module
----------
elasticslice.util.applicable module
-----------------------------
-----------------------------------
.. automodule:: elasticslice.util.applicable
:members:
......
......@@ -345,17 +345,17 @@ class ElasticSliceClientEndpoint(ProtoGeniClientServerEndpoint):
def SetResourceValues(self,params):
"""
@params["nodelist"] is a list of physical node resources. Each list
item must have at least the following key/value pairs:
item must have at least the following key/value pairs::
"node_id" : "<NODE_ID>"
"value" : float(0,1.0)
"node_id" : "<NODE_ID>"
"value" : float(0,1.0)
Each list item may also have the following values, if the server sends
them:
them::
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"component_urn" : "<COMPONENT_URN>"
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"component_urn" : "<COMPONENT_URN>"
"""
LOG.debug("SetResourceValues(%s)" % (str(params),))
......@@ -366,13 +366,13 @@ class ElasticSliceClientEndpoint(ProtoGeniClientServerEndpoint):
The server calls this method to tell us it is going to revoke some of
our resources. @params["nodelist"] is a list of physical
resources it is going to revoke. Each list item must have at
least the following key/value pairs:
least the following key/value pairs::
"node_id" : "<NODE_ID>" (the physical node_id)
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"max_wait_time" : <seconds>
"node_id" : "<NODE_ID>" (the physical node_id)
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"max_wait_time" : <seconds>
The server may call this method repeatedly as a sort of "countdown"
timer (by default it gets called every minute), and it will count down
the max_wait_time dict fields on each call. Thus, you have multiple
......@@ -401,12 +401,12 @@ class ElasticSliceClientEndpoint(ProtoGeniClientServerEndpoint):
Cloudlab's perspective, those nodes have been removed from your
experiment. @params["nodelist"] is a list of physical resources
it is going to revoke. Each list item must have at least the
following key/value pairs:
following key/value pairs::
"node_id" : "<NODE_ID>" (the physical node_id)
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"max_wait_time" : <seconds>
"node_id" : "<NODE_ID>" (the physical node_id)
"client_id" : "<CLIENT_ID>" (the client_id from the rspec, if this
client has this component_id allocated)
"max_wait_time" : <seconds>
The only valid response from this method is SUCCESS; it is ignored
anyway.
......
......@@ -106,7 +106,7 @@ class ApplicableMethod(object):
Python class decorators are a bit funny. First, the class of
the decorator is instantiated, and is passed all arguments given
to the ``@decorator()`` invocation. Second, after decorator
instantiation, the :method:`__call__` method is called with the
instantiation, the :func:`__call__` method is called with the
decorated function object.
:param help: the help string for the subcommand created for this function
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment