Latex命令\bar在Python docstring中无法正常工作

Question

我有一个docstring函数，如下所示

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

对未来访问者的另一种回答是：使用两个反斜杠而不是一个。它对于格式化上面提到的公式很有用，但也适用于以下用途：

print("/!\\ Error encountered.")

Answer 2

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}`,
    '''