fix doc warnings

parent d26504e2
Pipeline #1499 passed with stages
in 58 minutes and 47 seconds
......@@ -55,7 +55,10 @@ class RunningClients(Resource):
The *JSON* returned is:
::
[ 'client1', 'client2' ]
[
'client1',
'client2'
]
The output is filtered by the :mod:`burpui.misc.acl` module so that you
......@@ -455,7 +458,9 @@ class ClientsStats(Resource):
"state": "idle",
"phase": "phase1",
"percent": 12,
"labels": []
"labels": [
"toto"
]
},
{
"last": "never",
......@@ -463,7 +468,9 @@ class ClientsStats(Resource):
"state": "idle",
"phase": "phase2",
"percent": 42,
"labels": []
"labels": [
"titi"
]
}
]
}
......
......@@ -113,7 +113,7 @@ class Counters(Resource):
**GET** method provided by the webservice.
:param name: the client name if any. You can also use the GET parameter
'name' to achieve the same thing
'name' to achieve the same thing
:returns: Counters
"""
......@@ -196,7 +196,7 @@ class Live(Resource):
'counters': {
'phase': 2,
'path': '/etc/some/configuration',
'...': '...',
'...': '...'
}
},
{
......@@ -205,7 +205,7 @@ class Live(Resource):
'counters': {
'phase': 3,
'path': '/etc/some/other/configuration',
'...': '...',
'...': '...'
}
}
]
......
......@@ -49,13 +49,13 @@ class ServersStats(Resource):
{
'alive': true,
'clients': 2,
'name': 'burp1',
'name': 'burp1'
},
{
'alive': false,
'clients': 0,
'name': 'burp2',
},
'name': 'burp2'
}
]
......@@ -160,7 +160,7 @@ class ServersReport(Resource):
"linux": 4
},
"total": 349705,
"totsize": 119400711726,
"totsize": 119400711726
}
}
]
......
......@@ -215,7 +215,7 @@ class ServerSettings(Resource):
]
},
"server_doc": {
"address": "Defines the main TCP address that the server listens on. The default is either '::' or '0.0.0.0', dependent upon compile time options.",
"address": "Defines the main TCP address...",
"...": "..."
},
"string": [
......@@ -239,7 +239,9 @@ class ServerSettings(Resource):
"client",
"server"
],
"...": []
"...": [
"..."
]
}
}
......
......@@ -157,7 +157,7 @@ The server was launched with gunicorn:
gunicorn -k gevent -b 0.0.0.0:5000 -w 2 'burpui:create_app(conf="path/to/burpui.cfg")'
.. info:: The `parallel`_ backend is not compatible with gevent hence the different
.. note:: The `parallel`_ backend is not compatible with gevent hence the different
launching command.
Here are the results:
......
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