我使用iPython笔记本来解释我正在处理的图书馆,其中包含了许多科学背景和必要的例子。
使用笔记本,我可以使用注释嵌入代码并显示结果。但是对一个人有用的评论数量取决于他们的背景和目标,所以我不想放慢想要浏览的用户的速度,但我不想遗漏一个需要更深入解释的用户。
所以当我嵌入代码时,无论如何都要在评论中包含某种标记,以便某些单词可以成为工具提示?我是否必须使用plugin
自行构建例如,让我们说我有以下代码,在花括号中有额外的解释。
# 10ms post-[synaptic]{the thing that connects neurons} filter
filtered = nengo.Probe(neuron, synapse=0.01)
当它在笔记本中呈现时,您可以突出显示单词synaptic
,然后会弹出解释the things that connect neurons
。