python的文档源在哪里? (和Spyder文档功能)

时间:2014-05-26 21:17:28

标签: python spyder

为spyder(python IDE)保存的文档在哪里可以访问?

当我在spyder控制台中输入plot.savefig(时,我会弹出savefig()的文档。这是一个相当不错的功能,但只要我移动鼠标它就会消失。从哪里提取此文档?我搜索了/ doc文件夹,无法找到与matplotlib相关的任何内容。我想在另一台显示器上的PDF查看器中打开它。

import matplotlib.pyplot as plt
plt.savefig()

以下是文档的图片以供澄清:

Image of savefig doc

3 个答案:

答案 0 :(得分:5)

您所看到的文档来自您输入的函数的文档字符串。您可以使用plt.savefig.__doc__获取原始文本,或者使用内置{{{{{}获取格式。 1}}来自交互式解释器的命令:help。 Spyder将一些额外的花哨格式应用于其文档窗口的内容。

文档的详细程度因模块而异。在help(plt.savefig)的情况下,它非常详细,可能是因为维护人员已经付出了努力,以便在没有大量编程经验的情况下轻松使用该包。

关于你如何在Spyder之外查看这些文档的问题,我建议在线查看。我在matplotlib主页上看到他们有大量文档,包括web pages with the same contents as the docs you were seeing(可能是从相同的文档字符串生成的)。

答案 1 :(得分:1)

Spyder dev here )您所说的文档是plt.savefig(旁边的黄色小框,对吧?这些被称为calltips,我将它们修复到我们的下一个版本(2.3,现在在候选版本中),以便在鼠标悬停在屏幕上时将它们保留在屏幕上,如果单击它们或在某个后自动隐藏它们则隐藏它们时间。

备注

  1. 这不适用于Spyder 2.2.5或以前。
  2. 关于文档:我们计划在Object Inspector中添加标签,以便您可以同时查看多个文档页面。

答案 2 :(得分:0)

这可能与您现在无关,但现在您可以使用public class SampleModel { public string ParamName1 {get;set;} public int ParamName2 {get;set;} } 。这对于在spyder上迁移到python的R用户来说非常方便,因为两者都遵循相同的方式来显示文档。