doc_string which is the first argument of example, must be string object

[eisukeyeongjo]

doc_string which is the first argument of example, must be string object

[pirj]

@JonRowe do you agree with the expected behaviour section here?

doc_string which is the first argument of example, must be string object

It confuses me when the first argument is not a string and we accept it as metadata.
It seems to be a move in the wrong direction, bending to the pressure of existing specs that pass non-strings and expect that to work.

To me, the “must” in the “must be a string object” means we raise an argument error when it’s not.

In my defense, it :pending can become just pending, even though it’s just a special case, and it :clean_db doesn’t have/deserve such an alias.

I can foresee misuse and workarounds like it “”, :clean_db do.

I find it hard to justify the it pending: “not implemented yet” do as it gives no information on what wasn’t implemented exactly. But again, this is just a special case. Another example would be it platform: :ios, but that probably should be a context.

I’d love to see more examples of what we are going to break if we go with a more strict approach.

It’s more of a gut feeling, but going with accepting the first argument as metadata where it previously wasn’t, makes me uncomfortable when thinking of side effects that might be introduced by such metadata.

[pirj]

Sounds good, and no worries. Thanks for your contributions!

[eisukeyeongjo]

@pirj
Sorry for confusing you with this issue.
And I apologize for my lack of thought.
I understand what you mentioned above.
Certainly keeping the first argument doc_sting seems a right direction.
If you do not mind, i will re-write this issue and create new pull request.

What happens to this issue may depend on Mr. @JonRowe 's reply.
But I will try to face this issue a little more.