fix: plugins documentation generation#4973
Merged
kobenguyent merged 2 commits intocodeceptjs:3.xfrom May 7, 2025
Merged
Conversation
Lando1n
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the plugin documentation generation by re-enabling it and addressing formatting issues caused by the deprecated tag. Key changes include:
- Removing the early return in runok.js so that documentation is generated.
- Replacing the @deprecated tag with an inline comment in lib/plugin/commentStep.js.
- Regenerating and updating the docs/plugins.md file with revised headings and content formats.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| runok.js | Removed early return to enable plugin documentation generation. |
| lib/plugin/commentStep.js | Replaced deprecated tag with a comment indicating deprecation. |
| docs/plugins.md | Updated headings and text to improve documentation clarity. |
Comment on lines
+814
to
815
| This plugin can be disabled per test. In this case you will need to stet `I.retry()` to all flaky steps: | ||
|
|
There was a problem hiding this comment.
There is a typo in 'stet'; consider replacing it with 'set' for clarity.
Suggested change
| This plugin can be disabled per test. In this case you will need to stet `I.retry()` to all flaky steps: | |
| This plugin can be disabled per test. In this case you will need to set `I.retry()` to all flaky steps: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation/Description of the PR
This fixes the plugin documentation generation that was broken, then disabled recently.
I traced back the guilty commit to be f27e662, which led me to finding this bug within documentationjs/documentation#1596 where the
@deprecatedtag causes it to break formatting of headers.So I:
npm run def && npm run docsHow it currently looks:
However, I'm not sure how to validate what it looks like when hosted like this.
Applicable helpers:
Applicable plugins:
Type of change
Checklist:
npm run docs)npm run lint)npm test)