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

docs(angular): Properties that are spied upon have to be defined within componentProperties instead of on root level. #25359

Merged
merged 2 commits into from
Jan 6, 2023

Conversation

janpapenbrock
Copy link
Contributor

@janpapenbrock janpapenbrock commented Jan 4, 2023

Sorry for probably breaking the format for PR title and commit message, couldn't find a similar fix or the proper message guidelines.

User facing changelog

Documentation on createOutputSpy is incorrect in one place in the docs, whereas it is correct in other places. This PR fixes the wrong example.

Incorrect example: https://docs.cypress.io/guides/component-testing/angular/api#createOutputSpy

    mount(StepperComponent, { change: createOutputSpy('changeSpy') })

Correct example (other page in docs): https://docs.cypress.io/guides/component-testing/angular/examples#Testing-Event-Handlers

  cy.mount(StepperComponent, {
    componentProperties: {
      change: createOutputSpy('changeSpy'),
    },
  })

…componentProperties` instead of on root level.
@CLAassistant
Copy link

CLAassistant commented Jan 4, 2023

CLA assistant check
All committers have signed the CLA.

@ZachJW34 ZachJW34 changed the title fix(docs): Properties that are spied upon have to be defined within componentProperties instead of on root level. docs(angular): Properties that are spied upon have to be defined within componentProperties instead of on root level. Jan 4, 2023
@ZachJW34
Copy link
Contributor

ZachJW34 commented Jan 4, 2023

Thanks for the contribution @janpapenbrock! I've updated the PR title, appreciate you fixing this and LGTM!

@ZachJW34 ZachJW34 merged commit 4baad8e into cypress-io:develop Jan 6, 2023
@janpapenbrock janpapenbrock deleted the patch-angular-docs branch January 6, 2023 16:19
tgriesser added a commit that referenced this pull request Jan 18, 2023
* develop: (45 commits)
  fix: re-enable CYPRESS_INTERNAL_VITE_DEV development (#25364)
  fix: add skip domain injection description (#25463)
  fix: revert CSP header and script-src addition (#25445)
  chore: Update v8 snapshot cache (#25401)
  feat: Do not strip CSP headers from HTTPResponse (#24760)
  fix: keep spaces in formatted output in test runner (#24687)
  fix: Restrict dependency versions to known supported ranges (#25380)
  chore: Update v8 snapshot cache (#25370)
  feat: experimental skip domain injection (#25307)
  chore: support vite v4 for component testing (#25365)
  feat: Use JSX/TSX in generated spec filenames (#25318)
  docs(angular): Properties that are spied upon have to be defined within `componentProperties` instead of on root level. (#25359)
  chore: remove lint-changed from scripts/docs (#25308)
  chore: bump to 12.3.0 [skip ci] (#25355)
  fix: make NODE_ENV "production" for prod builds of launchpad (#25320)
  fix: .contains() should only return one element at all times (#25250)
  feat: add currentRetry to Cypress API (#25297)
  chore: release @cypress/webpack-dev-server-v3.2.2
  chore: release create-cypress-tests-v2.0.1
  fix: change wording for spec creation (#25271)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants