From 9190e1ec93faad390fafbe6d8a3d58132d1ef862 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Caron?= Date: Tue, 3 Dec 2024 14:41:45 +0100 Subject: [PATCH] docs: Add missing docstring --- qpbenchmark/problem.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/qpbenchmark/problem.py b/qpbenchmark/problem.py index 508fc79..14ba8cd 100644 --- a/qpbenchmark/problem.py +++ b/qpbenchmark/problem.py @@ -79,6 +79,14 @@ def __init__( @staticmethod def from_qpsolvers(qp: qpsolvers.Problem, name: str) -> "Problem": + """Stick a name to a generic problem from qpsolvers. + + Args: + name: Name of the problem. + + Returns: + Benchmark version of the problem. + """ return Problem( qp.P, qp.q,