roc icon indicating copy to clipboard operation
roc copied to clipboard

Include doc comments above `expect`s, not regular comments

Open rtfeldman opened this issue 3 years ago • 0 comments

Today, if I write this:

# x should be positive
expect > 0

...that comment will appear in the failed expectation.

We talked about it on Zulip and concluded that comments shouldn't be this semantically meaningful. Instead, we should require using doc comments for this, like so:

## x should be positive
expect > 0

Now the doc comment is "documenting" the expect, and comments are back to being non-semantic.

rtfeldman avatar Oct 04 '22 03:10 rtfeldman