Docstring for nyquist uses im as an output argument –> clash with the imaginary unit im

[hurak]

Docstring for nyquist

ControlSystems.jl/lib/ControlSystemsBase/src/freqresp.jl

Line 343 in 475758a

re, im, w = nyquist(sys[, w])

usesim as an output argument, but this unnecessarily clashes with the imaginary unit im in Julia.

In this particular case it can be even more troubling as some users of nyquist may want to create the full complex frequency response by assembling the provided real and imaginary parts as in G(jw) = re(jw) + i im(jw). In fact, this is how I myself encountered the trouble: Gjw = re + im*im.

Of course users can rename their output arguments as they like, but some of them may just copy and paste. And why promoting the habit of overwriting Julia's keywords.