TDAmeritrade / stumpy

STUMPY is a powerful and scalable Python library for modern time series analysis
https://stumpy.readthedocs.io/en/latest/
Other
3.68k stars 322 forks source link

Inline Code in Docstrings #993

Closed seanlaw closed 3 weeks ago

seanlaw commented 5 months ago

Currently, the docstring found in the STUMPY API page uses single backticks to denote inline code (e.g., `m`). However, this is incorrect and should be changed to double backticks so that things like variables can be rendered as inline code (e.g., ``m``).

Note that this should be done AFTER #986 is merged for fixing #772!