如何閱讀Python文檔

Question

我试图理解如何阅读python文档，例如给定的：
string.lstrip(s[, chars])
我该怎么读？我知道括号是可选的，但那是什么意思？是否有一个页面可以解释文档是如何编写的？在

Answer 1

文档中没有明确定义，但是

string.lstrip(s[, chars])

string是一个Python模块，它不是任何字符串（例如，它不能是"abc"）。在

参数s是要剥离的字符串（例如，它可以是"abc"）。这是强制性的，不是可选的。在

括号中的参数是可选的，它将是一个字符串，它的字符将从字符串中剥离。在

有关如何调用此函数的示例如下：

^{pr2}$

注意：不要与"abc".lstrip()混淆。它们是具有相同结果的不同函数。另外，请阅读@user2357112的评论。在

编辑：在我的IDE上，我刚刚测试了它，它实际上显示了文档上的s（按F2）：

def lstrip Found at: string

def lstrip(s, chars=None):
    """lstrip(s [,chars]) -> string

    Return a copy of the string s with leading whitespace removed.
    If chars is given and not None, remove characters in chars instead.

    """
    return s.lstrip(chars)

# Strip trailing tabs and spaces