Allow docstrings on tests #55

jariji · 2024-10-15T05:22:50Z

jariji
Oct 15, 2024

I like to put docstrings on my tests so I know what they are testing.

"abs returns a nonnegative value."
@check function abs_nonneg(x=Floats())
  zero(x) <= abs(x)
end

ERROR: cannot document the following expression

Seelengrab · 2024-10-16T16:12:54Z

Seelengrab
Oct 16, 2024
Maintainer

I don't think there's anything I can do to make that syntax work; you just can't put a docstring on a begin block expression (which is what's returned by @check) like that. However, since abs_nonneg is a function like any other, you can document it with @doc, or by documenting a function prototype:

"abs returns a nonnegative value."
function abs_nonneg end

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow docstrings on tests #55

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Allow docstrings on tests #55

Uh oh!

jariji Oct 15, 2024

Replies: 1 comment

Uh oh!

Uh oh!

Seelengrab Oct 16, 2024 Maintainer

jariji
Oct 15, 2024

Seelengrab
Oct 16, 2024
Maintainer