【问题标题】:Documentation with some text highlighted in gray一些文本以灰色突出显示的文档
【发布时间】:2019-03-30 17:23:10
【问题描述】:

在 Julia 中记录函数的选项很简单,很受欢迎。使用 Jupyter notebook 时是否可以突出显示文档中的某些关键字?

例如

"""
function ph(phoenix_one, phoenix-two)

      phoenix_one is an array of tuples containing information on height and weight, and phoenix-two contains position data.
"""
function ph(phoenix_one, phoenix-two)
    return phoenix_one + phoenix-two
end

?ph 被调用时

期望是:

phoenix_one 是一个包含身高和体重信息的元组数组,phoenix-two 包含位置数据。

而不是

phoenix_one 是一个包含身高和体重信息的元组数组,phoenix-two 包含位置数据。

即突出显示了一些关键字。

【问题讨论】:

    标签: jupyter-notebook julia code-documentation


    【解决方案1】:

    这里是这样做的方法(使用反引号+注意文档字符串的布局)

    """
        ph(phoenix_one, phoenix_two)
    
    `phoenix_one` is an array of tuples containing information on height and weight,
    and phoenix-two contains position data.
    """
    function ph(phoenix_one, phoenix_two)
        return phoenix_one + phoenix_two
    end
    

    【讨论】:

    • 我在 Jupyter 笔记本上试过这个,但没有得到想要的结果。
    • 我添加了一个屏幕截图,向您展示如何操作并证明它有效。
    • 我是否需要使用一些额外的包来实现这一点?我正在使用 Julia 1.0.3
    • 尝试在 JuliaBox 中运行它。我刚刚检查过,它的工作原理如上(您也可以在最后一个选项卡中检查使用的 nbextensions)。你如何启动 Jupyter?正常方式是运行using IJulia,然后运行notebook()
    猜你喜欢
    • 2021-09-09
    • 2018-08-29
    • 1970-01-01
    • 2017-07-05
    • 2016-06-07
    • 2016-07-28
    • 1970-01-01
    • 1970-01-01
    • 2016-03-29
    相关资源
    最近更新 更多