在 jupyter notebook 中通过 shift+tab 打开的帮助选项卡没有正确呈现 method/function 的文档字符串
The help tab opened by shift+tab in jupyter notebook doesn't render the docstring of a method/function properly
我正在尝试使用 jupyter notebook "shift+tab" 的重要快捷方式阅读函数或方法的文档(文档字符串),但它不会呈现文本适当地。
例如,在查看 confusion_matrix
函数的文档字符串时:
你可以看到突出显示的部分,我在实际文本之前渲染了那些奇怪的文本(math:)。这使得阅读文档字符串变得困难。我希望它像这样的 sklearn 文档一样呈现它,
我觉得有些库没有加载或下载。我刚开始使用 jupyter notebooks,所以请多关照 :)
PS: 我也试过重新启动主题但是没有用
我通常采用不同的方法。看看对你有没有帮助。
from sklearn.metrics import confusion_matrix
?confusion_matrix
运行 使用 运行 按钮或 shift+enter
的单元格
.. math::
是第一个标记。
他们在"under-progress" repo that Docstring doesn't support Mathematical notations, as they are written in -rst格式中提到。
坦率地说,目前Jupyter中还没有添加对reStructuredText的支持,因此您必须寻找方法来手动申请支持。查看 @akaihola's attempt 的比较问题。
我正在尝试使用 jupyter notebook "shift+tab" 的重要快捷方式阅读函数或方法的文档(文档字符串),但它不会呈现文本适当地。
例如,在查看 confusion_matrix
函数的文档字符串时:
你可以看到突出显示的部分,我在实际文本之前渲染了那些奇怪的文本(math:)。这使得阅读文档字符串变得困难。我希望它像这样的 sklearn 文档一样呈现它,
我觉得有些库没有加载或下载。我刚开始使用 jupyter notebooks,所以请多关照 :)
PS: 我也试过重新启动主题但是没有用
我通常采用不同的方法。看看对你有没有帮助。
from sklearn.metrics import confusion_matrix
?confusion_matrix
运行 使用 运行 按钮或 shift+enter
的单元格.. math::
是第一个标记。
他们在"under-progress" repo that Docstring doesn't support Mathematical notations, as they are written in -rst格式中提到。
坦率地说,目前Jupyter中还没有添加对reStructuredText的支持,因此您必须寻找方法来手动申请支持。查看 @akaihola's attempt 的比较问题。