Advanced examples

[noraj]

Advanced examples

[p0deje]

Sorry for the late response, I somehow missed this message in my inbox.

I think we could be smarter about comparing two values in a similar to #=== way so that it supports comparing instances to classes, strings to regular expressions, etc.

For example, we could write any of these and they should pass.

true #=> true
true #=> TrueClass

"string" #=> "string"
"string" #=> /str/

[1, 2, 3] #=> Array

That would be implemented in a similar way as Ruby's case keyword or pattern matching where all these examples also are equal. Do you think that would cover your cases? Meanwhile, you can still write docs in a similar way:

obj === Array #=> true

In general, however, I don't think we should aim to cover all the possible assertions/matchers. The doctests should be lightweight so that anyone could read the example and comprehend them without knowing that those are also tests.

[p0deje]

I've just pushed ca7bf2e - you can see an example how to use it to assert instance of the object.

I just hope that switching to case equality won't break anything to existing users. @noraj Do you mind giving a new version a try if you use yard-doctest?

[noraj]

I should give it a try for my next project.