Explain class: SwapCurveBuilderResult

[johannlilly]

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.

[google-cla]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

---

What to do if you already signed the CLA

Individual signers

• It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

• Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
• The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
• The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

[saxena-ashish-g]

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 ..."""

[saxena-ashish-g]

Thanks for the fix Johann.

Note that you will need to accept the CLA to merge the change.

[johannlilly]

@googlebot I signed it!

[cyrilchim]

Sorry for a slow reply. Could you please resolve my comment and I patch this in?

[cyrilchim]

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."""