Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain class: SwapCurveBuilderResult #44

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Explain class: SwapCurveBuilderResult #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api_docs/tf_quant_finance/rates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs are auto-generated from the inline code documentation. So the right way to fix this would be to modify the docstring of class SwapCurveBuilderResult defined in swap_curve_common.py.

SwapCurveBuilderResult is a namedtuple so we need to add the docstring in a roundabout way. My suggestion would be to do:

SwapCurveBuilderResult.doc = """Results from a swap curve construction ..."""

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

'Results from a swap curve construction.'

This is because actual curve fitting/building is done by swap_curve_fit method.

Instead of updating rates.md file, could you please navigate to SwapCurveBuilderResult and add

SwapCurveBuilderResult.doc = """Results from a swap curve construction."""


## Functions

Expand Down