为什么许多Python内置函数没有代码中的文档？

Question

train_kwargs 是一个标准的 Python dict（字典），我不太清楚 update(...) 这个方法具体是干嘛的，是把新的参数合并到字典里，还是把原来的所有键值都替换掉？

为了弄明白这个问题，我甚至不得不打开浏览器去查官方的在线文档，这真的影响了我的工作效率。

在内置类型和内置函数中，有很多例子没有代码中的文档，我就不一一列举了。

---

有些类和函数的文档写得很好，能在代码中找到。

Answer 1

因为你使用的开发环境有点问题。

你提到的例子，dict#update，其实Python本身提供了很好的内置帮助，但是你的开发环境没有显示出来。

$ python
Python 3.12.2 (main, Feb  6 2024, 20:19:44) [Clang 15.0.0 (clang-1500.1.0.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> help({}.update)

Help on built-in function update:

update(...) method of builtins.dict instance
    D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
    If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
    If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
    In either case, this is followed by: for k in F:  D[k] = F[k]

>>>