From c88a7d4a1750da0af1001a6ffbc33b33cca040a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johann=20Lilly=20=E6=9D=8E=E5=85=89=20=D9=8A=D9=88=D9=87?= =?UTF-8?q?=D8=A7=D9=86=20=D9=84=D9=8A=D9=84=20=D0=94=D0=B6=D0=BE=D0=BD=20?= =?UTF-8?q?=D0=9B=D0=B8=D0=BB=D0=BB=D0=B8?= Date: Mon, 8 Feb 2021 15:52:14 -0600 Subject: [PATCH] Explain class: SwapCurveBuilderResult Remove definition of class attributes, which are already detailed in the docs: SwapCurveBuilderResult.md. Instead, explain the use of the class using a similar convention found under other Class headers in the docs. --- api_docs/tf_quant_finance/rates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api_docs/tf_quant_finance/rates.md b/api_docs/tf_quant_finance/rates.md index 544b820d9..4d61f6872 100644 --- a/api_docs/tf_quant_finance/rates.md +++ b/api_docs/tf_quant_finance/rates.md @@ -37,7 +37,7 @@ Functions to handle rates. ## Classes -[`class SwapCurveBuilderResult`](../tf_quant_finance/rates/SwapCurveBuilderResult.md): SwapCurveBuilderResult(times, rates, discount_factors, initial_rates, converged, failed, iterations, objective_value) +[`class SwapCurveBuilderResult`](../tf_quant_finance/rates/SwapCurveBuilderResult.md): Build curves for swapping future cash flows. ## Functions