Comment les fonctions définies par l'utilisateur (par exemple f
) peuvent-elles avoir des impressions significatives lorsqu'elles sont inspectées via le REPL en utilisant ?f
ouhelp(f)
Par exemple, imaginez que j'écris la fonction suivante
function f(x::Float64, y::Float64)
return 2x - y^2
end
Si je charge ceci dans une session julia et que j'essaye, help(f)
j'obtiens ce qui suit:
julia> help(f)
f (generic function with 1 method)
Et si à la place je voulais voir quelque chose comme
julia> help(f)
f
Compute 2 times x minus y squared
où la description "Calculer 2 fois x moins y au carré" est écrite quelque part. J'imagine que la réponse à ma question peut être déterminée à partir de la réponse à la question "Où est le quelque part où la description doit être écrite?"
A titre d'exemple, si je voulais faire la même chose en python, je pourrais définir la fonction et mettre la description en docstring:
def f(x, y):
"""
Compute 2 times x minus y squared
"""
return 2 * x - y ** 2
ce qui rendrait ma description immédiatement disponible lorsque je tape help(f)
ou f?
depuis IPython.