Документация с некоторым текстом, выделенным серым цветом - PullRequest
1 голос
/ 30 марта 2019

Опция документировать функции в Джулии проста, что приветствуется.Можно ли выделить некоторые ключевые слова в документации при использовании ноутбука Jupyter?

Например,

"""
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 - это массив кортежей, содержащийинформация о росте и весе, а Феникс-2 содержит данные о положении.

То есть с некоторыми выделенными ключевыми словами.

1 Ответ

1 голос
/ 30 марта 2019

Вот способ сделать это (используйте галочки + отметьте расположение строки документа)

"""
    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

enter image description here

...