Question

我试图理解我应该如何阅读python文档，例如： string.lstrip(s[, chars])
我该怎么读？我知道括号意味着可选，但那是'，它是什么意思？是否有一个页面说明了如何编写文档？

Answer 1

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

中

string.lstrip(s[, chars])

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

参数s是您要删除的字符串（例如，它可以是"abc"）。这是强制性的，而不是可选的。

括号括起的参数是可选，它将是一个字符串，其字符将从字符串中删除。

如何调用此函数的一些示例是：

import string

print string.lstrip("abc", "a") # "bc"
print string.lstrip(" abc") # "abc"

注意：请勿与"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

如何阅读Python文档

1 个答案: