feat: render constructors in Node.js API style#24
Merged
avivkeller merged 3 commits intowebpack:mainfrom Mar 14, 2026
Merged
Conversation
avivkeller
approved these changes
Mar 14, 2026
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.
Summary
This PR modifies the constructor rendering in webpack-doc-kit to match the Node.js API documentation style. Previously, constructors were rendered with a generic #### Constructor heading followed by the signature. This change overrides the constructorpartial to render the heading as ####
new ClassName(params).Motivation: Improve readability and consistency with Node.js API documentation conventions.
Problem solved: Removes the generic "Constructor" heading and replaces it with the specific instantiation syntax.
Logic: Implemented parameter formatting in the
constructor
partial, including specialized handling for optional parameters (bracketed with commas).
Fixes #2.
What kind of change does this PR introduce?
feat (Documentation rendering improvement)
Did you add tests for your changes?
Yes, verified by running npm run generate-docs and confirming the output in the pages/v5.x/ directory across multiple classes (including Compiler, AsyncDependenciesBlock, and Cache).
Does this PR introduce a breaking change?
No.
The changes are already documented in the updated generated markdown files in the pages/ directory included in this PR.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
Use of AI
I used AI (Google's Antigravity assistant with Claude Sonnet) for initial codebase navigation and syntax research. All logic design, code implementation, and final verification were discussed with the AI, then executed manually by me.