diff options
| author |   Viliam Luc <vluc@cisco.com> | 2021-10-28 15:05:53 +0200 |
|---|---|---|
| committer |   Tibor Frank <tifrank@cisco.com> | 2021-12-13 10:57:25 +0000 |
| commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
| tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /resources/libraries/python/Constants.py | |
| parent | f87931f3c85fe71bb3124e787168abafc5874c54 (diff) | |
doc: fixing documentation structure
When building documentation using sphinx we see ~1200 similar warnings [0]
[0] - https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-verify-tox-master-ubuntu2004-x86_64/3289/doc_verify.log.gz
These warning are harmless and can be fixed later
Signed-off-by: Viliam Luc <vluc@cisco.com>
Change-Id: I1ac1099d38935971d47491dde905715345d3935c
Diffstat (limited to 'resources/libraries/python/Constants.py')
| -rw-r--r-- | resources/libraries/python/Constants.py | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/resources/libraries/python/Constants.py b/resources/libraries/python/Constants.py index c6c9bcaf05..c14ba31c57 100644 --- a/resources/libraries/python/Constants.py +++ b/resources/libraries/python/Constants.py @@ -428,23 +428,24 @@ class Constants: } PERF_TYPE_TO_SUITE_DOC_VER = { - u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\ -| ... | at line rate and reports total received packets over trial period.\\''', - u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\ -| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\ -| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\ -| ... | of packets transmitted. NDR and PDR are discovered for different\\ -| ... | Ethernet L2 frame sizes using MLRsearch library.\\''', - u"soak": u'''fication:* TG sends traffic at dynamically computed\\ -| ... | rate as PLRsearch algorithm gathers data and improves its estimate\\ -| ... | of a rate at which a prescribed small fraction of packets\\ -| ... | would be lost. After set time, the serarch stops\\ -| ... | and the algorithm reports its current estimate.\\''', + u"mrr": u'''fication:** In MaxReceivedRate tests TG sends traffic at \\ +| ... | line rate and reports total received packets over trial period. \\''', + u"ndrpdr": u'''rification:** TG finds and reports throughput NDR (Non \\ +| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \\ +| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \\ +| ... | expressed in percentage of packets transmitted. NDR and PDR are \\ +| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \\ +| ... | library.''', + u"soak": u'''rification:** TG sends traffic at dynamically computed \\ +| ... | rate as PLRsearch algorithm gathers data and improves its estimate \\ +| ... | of a rate at which a prescribed small fraction of packets \\ +| ... | would be lost. After set time, the serarch stops \\ +| ... | and the algorithm reports its current estimate. \\''', } PERF_TYPE_TO_TEMPLATE_DOC_VER = { - u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\ -| | ... | using burst trials throughput test.\\''', - u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\", - u"soak": u"Estimate critical rate using PLRsearch algorithm.\\", + u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames \\ +| | ... | using burst trials throughput test. \\''', + u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.", + u"soak": u"Estimate critical rate using PLRsearch algorithm. \\", } |