chore(doclint): support classes inheritance #935
Merged
Conversation
This file contains 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
This patch: - gives meaningful names to doclint tests - supports classes inheritance in documentation linter. When class A extends class B, all methods of class B are added to documentation of class A. This is a prerequisite for Object Handles: ElementHandle will be extending ObjectHandle. References puppeteer#382
| for (const source of sources) { | ||
| const outline = new JSOutline(source.text()); | ||
| classes.push(...outline.classes); | ||
| errors.push(...outline.errors); | ||
| for (let entry of outline.inheritance) |
There was a problem hiding this comment.
Why are we cloning the map?
There was a problem hiding this comment.
that's because super classes are not necessarily defined in the same file
| const classesByName = new Map(classes.map(cls => [cls.name, cls])); | ||
| return classes.map(cls => { | ||
| const membersMap = new Map(); | ||
| for (let wp = cls; wp; wp = classesByName.get(inheritance.get(wp.name))) { |
There was a problem hiding this comment.
What does wp stand for?
JoelEinbinder
approved these changes
Oct 2, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This patch:
extends class B, all methods of class B are added to documentation of
class A.
This is a prerequisite for Object Handles: ElementHandle will be
extending ObjectHandle.
References #382