Reversed argument order in .then

[superMDguy]

Current behavior:

According to this line, the .then function has a signature of (subject, options, fn). The docs say that, like most other cypress functions, the options is the last argument, so (subject, fn, options).

Desired behavior:

The signature should be (subject, fn, options), to be consistent with the docs and other cypress functions. However, that could break others' existing tests. So, maybe a better solution would be to just update the docs with the correct argument order.

Steps to reproduce:

n/a

Versions

n/a

[jennifer-shehane]

The docs say that, like most other cypress functions, the options is the last argument, so (subject, fn, options)

The syntax indicates the options is the first argument (if needed) here:

I suppose you are referring to the order of the Arguments as listed, with the fn first and options last - indicating that this reflects the order or arguments.

This does seem to coincidentally be the case on most of the API docs. I seriously doubt we will change to order of the option in the API itself.

So, I created a new issue in our docs to update this here: cypress-io/cypress-documentation#618. Our documentation is open source and contributions are welcome. 😄

[superMDguy]

Somehow I missed the syntax section, since I was looking at the arguments section. It's kind of strange that the options are the first argument in this command, but I agree that changing the docs is the best option.