Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document TS for common methods better #1117

Closed
bahmutov opened this issue Dec 21, 2017 · 3 comments
Closed

Document TS for common methods better #1117

bahmutov opened this issue Dec 21, 2017 · 3 comments
Assignees
Labels
topic: typescript type: enhancement Requested enhancement of existing feature type: user experience Improvements needed for UX
Milestone

Comments

@bahmutov
Copy link
Contributor

Cypress 1.4.0

I looked at the IntelliSense popups in the project https://github.com/cypress-io/cypress-example-todomvc and the results are not very useful. While they could be useful (there is some formatting that I had to adjust on cy.type example to get this to work) like for cy.type

cytype

Many other code popups were useless.

For example, cy itself needs to be documented

cyitself

cy.visit is ok, but the example needs to be tweaked to be displayed properly. Here is what works

/**
 * Type into a DOM element.
 *
 * @see https://on.cypress.io/type
 * @example
 *
 *    // type "Hello, World" into the <input> element
 *    cy.get('input').type('Hello, World')
 */
type...

The example is indented without any other text

cyvisit

cy.get is scary

cyget

cy.should('have.class'...) and other assertions need documentation

cyshouldhaveclass

@bahmutov bahmutov self-assigned this Dec 21, 2017
@bahmutov bahmutov added topic: typescript type: enhancement Requested enhancement of existing feature type: user experience Improvements needed for UX labels Dec 21, 2017
@bahmutov
Copy link
Contributor Author

I think if I can make cypress-example-todomvc have good helpful intellisense it will cover the basics.

@bahmutov bahmutov changed the title Document Document TS for common methods better Dec 22, 2017
@bahmutov
Copy link
Contributor Author

much better

screen shot 2017-12-22 at 11 22 11 am

bahmutov added a commit that referenced this issue Dec 22, 2017
@bahmutov bahmutov added this to the 1.4.1 milestone Dec 22, 2017
@brian-mann
Copy link
Member

Released in 1.4.1.

NicholasBoll added a commit to NicholasBoll/cypress that referenced this issue Dec 27, 2017
brian-mann pushed a commit that referenced this issue Jan 9, 2018
* fix: within type definition

* doc: should/and chainer autocomplete

* chore: Updated example documentation to match #1117
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: typescript type: enhancement Requested enhancement of existing feature type: user experience Improvements needed for UX
Projects
None yet
Development

No branches or pull requests

2 participants