Latex 命令 \bar 在 Python 文档字符串中无法正常工作

Question

我有一个带有如下文档字符串的函数，

def func(x):

    '''Boring function

    Notes
    -----
    Let :math:`\bar{x}_k = \sum_{i=1}^{n_k}x_{ik}`,
    '''

    return x

但是 Latex 中的 \bar 命令呈现为 "ar",

Answer 1

Python 正在解释反斜杠。您需要传递反斜杠以便 LaTeX 可以解释它们；你应该使用 raw string 这样做：

def func(x):

    # Note the r!
    r'''Boring function

    Notes
    -----
    Let :math:`\bar{x}_k = \sum_{i=1}^{n_k}x_{ik}`,
    '''

Answer 2

给未来访客的备选答案：使用两个反斜杠而不是一个。正如我们在上面看到的那样，它对格式化公式很有用，但也可用于以下用途：

print("/!\ Error encountered.")

Latex command \bar not working properly in Python docstring