Джулия, эквивалентная Python "help ()" - PullRequest
Новая
       4

Джулия, эквивалентная Python "help ()"

2 голосов
/ 11 июня 2019

В python, чтобы получить документацию по функции, мы можем напечатать (например) help(len).

Как сделать то же самое, чтобы получить документацию по функции в Julia?

1 Ответ

4 голосов
/ 11 июня 2019

В Julia вы можете использовать вопросительный знак, за которым следует имя функции, то есть ?functionname, чтобы получить информацию о функции.

Если вы используете REPL , вопросmark переключит ваше приглашение julia> на приглашение help?> - аналогично тому, как ] вызывает режим pkg> REPL.Обратитесь к документации для получения дополнительной информации.

В записных книжках Jupyter (IJulia) вы просто набираете ?println и видимых изменений режима REPL нет.

Пример: 

help?> println # I typed ?println
search: println printstyled print sprint isprint

  println([io::IO], xs...)

  Print (using print) xs followed by a newline. If io is not supplied, prints to stdout.

  Examples
  ≡≡≡≡≡≡≡≡≡≡

  julia> println("Hello, world")
  Hello, world

  julia> io = IOBuffer();

  julia> println(io, "Hello, world")

  julia> String(take!(io))
  "Hello, world\n"

Обратите внимание, что этот подход не ограничивается функциями.Он работает для всех объектов, к которым прикреплены некоторые строки документов: 

help?> Sys.CPU_THREADS # docstring of a constant
  Sys.CPU_THREADS

  The number of logical CPU cores available in the system, i.e. the number of threads that the CPU can run concurrently. Note that this is not necessarily the number of CPU cores, for example, in the presence of hyper-threading (https://en.wikipedia.org/wiki/Hyper-threading).

  See Hwloc.jl or CpuId.jl for extended information, including number of physical cores.
...