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

chore(docs): fix some formatting in Playwright.md #4066

Closed
wants to merge 1 commit into from
Closed

chore(docs): fix some formatting in Playwright.md #4066

wants to merge 1 commit into from

Conversation

elbotho
Copy link

@elbotho elbotho commented Dec 11, 2023

Motivation/Description of the PR

  • replace wrong code example for `resizeWindow
  • Fixes some code rendering and makes it a bit more readable

Type of change

  • 🔥 Breaking changes
  • 🚀 New functionality
  • 🐛 Bug fix
  • 📋 Documentation changes/updates
  • ♨️ Hot fix
  • 🔨 Markdown files fix - not related to source code
  • 💅 Polish code

Checklist:

  • Tests have been added
  • Documentation has been added (Run npm run docs)
  • Lint checking (Run npm run lint)
  • Local tests are passed (Run npm test)

Copy link
Collaborator

@kobenguyent kobenguyent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @elbotho thanks for your contribution!

So just let you know the documentation fixes would be not as simple as we see.

sometimes you need to visit https://github.com/codeceptjs/CodeceptJS/tree/3.x/docs and find the relevant changes there, sometimes the changes are at JSDocs of helper itself.

After making changes, you shall need to run npm run docs to make the docs sync everywhere.

@elbotho
Copy link
Author

elbotho commented Dec 16, 2023

@kobenguyent thank you for the feedback.
Then it seems to be a problem with the import happening at {{> resizeWindow }} or inside of runok.js (the rest of the jsdoc comment just get's appended) and I'm sorry but I could not figure that out in a reasonable time.

@elbotho elbotho closed this Dec 16, 2023
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.

3 participants