keystonejs / keystone-nightwatch-e2e

⚠️ Archived - Legacy end-to-end test framework for KeystoneJS applications.
https://keystonejs.github.io/keystone-nightwatch-e2e/javadoc/
MIT License
17 stars 7 forks source link

`assertFieldInputs` docs are slightly misleading? #15

Open jstockwin opened 7 years ago

jstockwin commented 7 years ago

The docs are here: https://keystonejs.github.io/keystone-nightwatch-e2e/javadoc/module-adminUIItemScreen.html#~assertFieldInputs

However, what we actually call is this: https://github.com/keystonejs/keystone/blob/master/test/e2e/adminUI/tests/group006Fields/testEmailField.js#L81

Specifically, we call { name: 'name', input: { value: 'Email Field Test 1' }, }, whereas the docs make it seems like this should be { name: 'name', input: 'Email Field Test 1' }, They make no mention of value.

@webteckie What do you think?

webteckie commented 7 years ago

@jstockwin yes, the javadocs for the methods should be updated.

jstockwin commented 7 years ago

@webteckie And which way is correct? We're also passing options to the fieldTestObject, so the extra value bit seems unnecessary to me. Will mean every single keystone test needs updating again though, so maybe we keep it as it is and update the docs?

webteckie commented 7 years ago

@jstockwin I ponder this decision a bit and ultimately decided on the existing syntax. My preference is to update the docs but up to you :-)

jstockwin commented 7 years ago

Fine with me :)

On Fri, 11 Nov 2016, 12:24 Carlos Colon, notifications@github.com wrote:

@jstockwin https://github.com/jstockwin I ponder this decision a bit and ultimately decided on the existing syntax. My preference is to update the docs but up to you :-)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/keystonejs/keystone-nightwatch-e2e/issues/15#issuecomment-259946871, or mute the thread https://github.com/notifications/unsubscribe-auth/AH2Lrx2SyBiKczphiV4ExBKOlPnoPR8Bks5q9F6WgaJpZM4KvK7q .