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

时间:2016-05-26 20:07:56

标签: python latex docstring

我有一个带有docstring的函数,如下所示,

def func(x):

    '''Boring function

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

    return x

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

enter image description here

2 个答案:

答案 0 :(得分:3)

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

答案 1 :(得分:1)

未来访客的替代答案:使用两个反斜杠代替一个。如上所见,它对于格式化公式很有用,但对于以下用途也是如此:

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