Move docstrings inline from helpdb - Part 2 #22618
Conversation
base/special/trig.jl
Outdated
| (:secd, :cosd), (:cscd, :sind), (:cotd, :tand)) | ||
| for (finv, f, finvh, fh, finvd, fd, fn) in ((:sec, :cos, :sech, :cosh, :secd, :cosd, "secant"), | ||
| (:csc, :sin, :csch, :sinh, :cscd, :sind, "cosecant"), | ||
| (:cot, :tan, :coth, :tahnh, :cotd, :tand, "cotangent")) |
There was a problem hiding this comment.
Perhaps align the second and third tuples to the front of the first tuple, rather than to the end of the first tuple? (Edit: E.g. as in the preexisting loop.)
There was a problem hiding this comment.
Thanks for the feedback! I aligned the second and third tuples as such because I'm just already over the 92 character line length with the current formatting. In that case, do you think I should leave as is, or still realign?
There was a problem hiding this comment.
Good question! Perhaps @tkelman, arbiter of all things line length, can make that call? :)
There was a problem hiding this comment.
either way. 92 is a recommendation rather than a hard limit, and I think the way @xorJane has this formatted now is fine too
There was a problem hiding this comment.
though tanh is spelled wrong
There was a problem hiding this comment.
Whoops. Fixed the spelling and also chose to realign. :)
There was a problem hiding this comment.
I hope our tests would have caught that. If not we've got a coverage hole.
…`, and `base/parse.jl
| @eval begin | ||
| ($finv)(z::T) where {T<:Number} = one(T) / (($f)(z)) | ||
| @doc """ |
There was a problem hiding this comment.
Just curious; why is the @doc needed here?
There was a problem hiding this comment.
You are correct, the @doc is not necessary: The @doc would be necessary absent the eval due to the scope introduced by the for, but the eval lifts evaluation out of the for's scope.
Apologies, this error was mine! I misled @xorJane and @OliverEvans96 while reviewing these changes at JuliaCon. Best!
To note, I refactored docstring generation for
csc*(x),sec*(x), andcot*(x).From #22521
<3!