This PR adds :py:func: to two functions in the docstrings.
@lbluett - @tennlee suggested I tag you, just in case you wanted to take a look. You don't need to do anything about this PR, no action is required on your part. But Tennessee said that you were taking an interest in how the documentation works, and he thought you might be interested in knowing about this. Adding ":py:func:" before a function name means when it is built in the API documentation in Read the Docs, it forms a hyperlink that when clicked takes you to the API docstring in question.
E.g. when rendered in Read the Docs it looks like the screenshot below, and if you click on the link (in the docstring in Read the Docs) it takes you to the flip_flop_index docstring in Read the Docs:
This PR adds :py:func: to two functions in the docstrings.
@lbluett - @tennlee suggested I tag you, just in case you wanted to take a look. You don't need to do anything about this PR, no action is required on your part. But Tennessee said that you were taking an interest in how the documentation works, and he thought you might be interested in knowing about this. Adding ":py:func:" before a function name means when it is built in the API documentation in Read the Docs, it forms a hyperlink that when clicked takes you to the API docstring in question.
E.g. when rendered in Read the Docs it looks like the screenshot below, and if you click on the link (in the docstring in Read the Docs) it takes you to the flip_flop_index docstring in Read the Docs:
You can see this at the bottom of the
scores.continuous.flip_flop_index_proportion_exceedingAPI docstring here: https://scores.readthedocs.io/en/latest/api.html#scores.continuous.flip_flop_index_proportion_exceeding