-
Notifications
You must be signed in to change notification settings - Fork 444
API Descriptions Update #1940
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
Merged
Merged
API Descriptions Update #1940
Changes from 1 commit
Commits
Show all changes
97 commits
Select commit
Hold shift + click to select a range
6bdf491
chore: remove the old json file
Bashamega 5d9b1b3
docs: update README to remove deprecatedMessage.json reference
Bashamega de0d117
feat: implement GitHub API integration to fetch index.md file descrip…
Bashamega 39d5719
ci: add GITHUB_TOKEN to CI workflow environment
Bashamega df3631e
feat: add mdn-content submodule for documentation resources
Bashamega e9c9379
chore: revert
Bashamega 8e74526
feat: add script to recursively retrieve folder paths for API documen…
Bashamega 40e5317
feat: add generate script to build process for description generation
Bashamega d7c6297
feat: enhance description generation by adding index.md content retri…
Bashamega 51bc9cb
refactor: simplify folder retrieval logic in generateDescriptions.ts
Bashamega af54369
feat: update output path for generated API descriptions JSON file
Bashamega 1bb475e
-
Bashamega 2695f20
feat: add summary extraction from index.md content for description ge…
Bashamega 5a5cbdd
feat: generate the API descriptions
Bashamega 66f5156
fix: json format
Bashamega 61d4fde
refactor: improve code readability and formatting in generateDescript…
Bashamega c06f21b
chore: generate baseline
Bashamega c110920
chore: generate
Bashamega ed6f97f
feat: refactor generateDescriptions to export generateDescription fun…
Bashamega afbb9e1
refactor: enhance generateDescription function to improve Markdown pr…
Bashamega c854ebb
chore: build
Bashamega 17ded6a
-
Bashamega 4c87230
format
Bashamega 47bd142
Merge branch 'microsoft:main' into 1937
Bashamega 5933dd8
adds missing libs
Bashamega 0ce76d5
Modify the regexes
Bashamega 6ff87d9
fix: This string may still contain <script , which may cause an HTML …
Bashamega 3b416ad
fix: regex in cleanText function to prevent exponential backtracking
Bashamega b8d9480
chore: don't delete the api descriptions, if the submodule doesn't exist
Bashamega ad92293
feat: unit tests
Bashamega 5d58288
-
Bashamega c1ad6ea
get only the first paragraph
Bashamega 8402152
fix: update API description generation to return data instead of savi…
Bashamega 445fa89
chore: remove json file
Bashamega 4a9adfa
chore: update .gitignore
Bashamega 28bfccf
Re-add mdn submodule
Bashamega faca57f
remove old submodule
Bashamega ba429e0
chore: update dir
Bashamega ee545fc
refactor: simplify text cleaning logic in generateDescriptions.ts
Bashamega 6232f92
Make it take the full sentence
Bashamega bfbfcbb
fix workflow
Bashamega 8e5651c
chore: fetch submodules
Bashamega 46ed6ae
fix
Bashamega 4f02639
fix
Bashamega dea3437
chore: updates deploy
Bashamega afeef87
-
Bashamega 8f1ca09
Restore
Bashamega 499e76e
linter
Bashamega 156c52d
feat: markdown libs
Bashamega 4f48c8d
fix
Bashamega 1d050d3
remove parser
Bashamega bff43b4
remove backstick
Bashamega b9d231b
remove extra steps
Bashamega fe739ba
adds back sticks
Bashamega 6f7c6cf
-
Bashamega acc701a
remove extra chore
Bashamega c0b174b
-
Bashamega aeb2d85
fix: prevent sentence split before abbreviations like "i.e." and "e.g."
Bashamega 65213fe
generate baselines
Bashamega 26b2047
fix: improve title extraction by removing trailing 'extension'
Bashamega d899655
refactor: update fs import to use promises module
Bashamega 4c51aa9
move and rename the generate descriptions file
Bashamega bb2d85a
urls
Bashamega 1f4f5f1
removes fs
Bashamega e4a1eb4
removes redirect
Bashamega 6166a1f
-
Bashamega 3f18c23
chore: removes url and path
Bashamega 7289d10
refactor: update directory handling to use URL objects
Bashamega 2dbb91b
fix
Bashamega 1693dbd
-
Bashamega f2ab8d1
refactor: update workflow to include submodule handling
Bashamega 2a3ead7
update submodule
Bashamega 5894b0d
-
Bashamega 2710f19
-
Bashamega f18a444
-
Bashamega f9d9bf8
rename workflow
Bashamega 5ec693d
-
Bashamega 8868c1d
Update update-core-deps.yml
Bashamega b3cf7d6
Merge branch 'microsoft:main' into 1937
Bashamega 4008574
Update update-core-deps.yml
Bashamega 9ed120d
Update mdn-comments.ts
Bashamega 6bd4822
Update README.md
Bashamega 6ba9eea
Update submodule
Bashamega d2d7817
Update update-core-deps.yml
Bashamega 0e5b7c8
Merge branch 'microsoft:main' into 1937
Bashamega 9e1b9de
generate
Bashamega 56935fe
-
Bashamega aa1d888
Update README.md
Bashamega 434acbf
Update package-lock.json
Bashamega d960681
revert
Bashamega 79d2845
-
Bashamega 22cb393
Merge branch 'main' into 1937
Bashamega 3365a61
-
Bashamega 1ba1b36
-
Bashamega 1a888c7
-
Bashamega a220c15
-
Bashamega eea3294
Update README.md
Bashamega File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
fix
- Loading branch information
commit 4f48c8de2c2b640342a7d003187f8580ab02010e
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2872,7 +2872,7 @@ interface AnimationFrameProvider { | |
} | ||
|
||
/** | ||
* Of the [Web Animations API](/en-US/docs/Web/API/Web_Animations_API) represents animation events. | ||
* The AnimationPlaybackEvent interface of the Web Animations API represents animation events. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AnimationPlaybackEvent) | ||
*/ | ||
|
@@ -4019,7 +4019,7 @@ declare var CSSMathClamp: { | |
}; | ||
|
||
/** | ||
* The **CSSMathInvert** interface of the CSS Typed Object Model API represents a CSS calc used as calc(1 / ). It inherits properties and methods from its parent CSSNumericValue. | ||
* The **CSSMathInvert** interface of the CSS Typed Object Model API represents a CSS calc used as calc(1 / <value>). It inherits properties and methods from its parent CSSNumericValue. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CSSMathInvert) | ||
*/ | ||
|
@@ -9356,7 +9356,7 @@ declare var File: { | |
}; | ||
|
||
/** | ||
* The **FileList** interface represents an object of this type returned by the files property of the HTML input element; this lets you access the list of files selected with the element. | ||
* The **FileList** interface represents an object of this type returned by the files property of the HTML input element; this lets you access the list of files selected with the <input type='file'> element. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FileList) | ||
*/ | ||
|
@@ -9859,7 +9859,7 @@ declare var GamepadButton: { | |
}; | ||
|
||
/** | ||
* This Gamepad API interface contains references to gamepads connected to the system, which is what the gamepad events {{domxref("Window.gamepadconnected_event", "gamepadconnected")}} and {{domxref("Window.gamepaddisconnected_event", "gamepaddisconnected")}} are fired in response to. | ||
* The GamepadEvent interface of the Gamepad API contains references to gamepads connected to the system, which is what the gamepad events Window.gamepadconnected_event and Window.gamepaddisconnected_event are fired in response to. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Still some domxref? 👀 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have fixed it. I forgot to remove templates when I have migrated it to the build file |
||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadEvent) | ||
*/ | ||
|
@@ -11694,7 +11694,7 @@ declare var HTMLHeadElement: { | |
}; | ||
|
||
/** | ||
* The **HTMLHeadingElement** interface represents the different heading elements, through . | ||
* The **HTMLHeadingElement** interface represents the different heading elements, <h1> through <h6>. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLHeadingElement) | ||
*/ | ||
|
@@ -12469,7 +12469,7 @@ declare var HTMLLegendElement: { | |
}; | ||
|
||
/** | ||
* The **HTMLLinkElement** interface represents reference information for external resources and the relationship of those resources to a document and vice versa (corresponds to element; not to be confused with , which is represented by HTMLAnchorElement). | ||
* The **HTMLLinkElement** interface represents reference information for external resources and the relationship of those resources to a document and vice versa (corresponds to <link> element; not to be confused with <a>, which is represented by HTMLAnchorElement). | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLLinkElement) | ||
*/ | ||
|
@@ -12879,7 +12879,7 @@ declare var HTMLMenuElement: { | |
}; | ||
|
||
/** | ||
* The **HTMLMetaElement** interface contains descriptive metadata about a document provided in HTML as elements. | ||
* The **HTMLMetaElement** interface contains descriptive metadata about a document provided in HTML as <meta> elements. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMetaElement) | ||
*/ | ||
|
@@ -13236,7 +13236,7 @@ declare var HTMLOptionElement: { | |
}; | ||
|
||
/** | ||
* The **HTMLOptionsCollection** interface represents a collection of HTML elements (in document order) and offers methods and properties for selecting from the list as well as optionally altering its items. | ||
* The **HTMLOptionsCollection** interface represents a collection of <option> HTML elements (in document order) and offers methods and properties for selecting from the list as well as optionally altering its items. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection) | ||
*/ | ||
|
@@ -13514,7 +13514,7 @@ declare var HTMLQuoteElement: { | |
}; | ||
|
||
/** | ||
* HTML script elements expose the **HTMLScriptElement** interface, which provides special properties and methods for manipulating the behavior and execution of elements (beyond the inherited HTMLElement interface). | ||
* HTML script elements expose the **HTMLScriptElement** interface, which provides special properties and methods for manipulating the behavior and execution of <script> elements (beyond the inherited HTMLElement interface). | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLScriptElement) | ||
*/ | ||
|
@@ -20724,7 +20724,7 @@ declare var SVGAElement: { | |
}; | ||
|
||
/** | ||
* The SVGAngle interface is used to represent a value that can be an or value. | ||
* The SVGAngle interface is used to represent a value that can be an <angle> or <number> value. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGAngle) | ||
*/ | ||
|
@@ -20810,7 +20810,7 @@ declare var SVGAnimateTransformElement: { | |
}; | ||
|
||
/** | ||
* The SVGAnimatedAngle interface is used for attributes of basic type \ which can be animated. | ||
* The SVGAnimatedAngle interface is used for attributes of basic type \<angle> which can be animated. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGAnimatedAngle) | ||
*/ | ||
|
@@ -20861,7 +20861,7 @@ declare var SVGAnimatedEnumeration: { | |
}; | ||
|
||
/** | ||
* The SVGAnimatedInteger interface is used for attributes of basic type \ which can be animated. | ||
* The SVGAnimatedInteger interface is used for attributes of basic type \<integer> which can be animated. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGAnimatedInteger) | ||
*/ | ||
|
@@ -20878,7 +20878,7 @@ declare var SVGAnimatedInteger: { | |
}; | ||
|
||
/** | ||
* The **SVGAnimatedLength** interface represents attributes of type \ which can be animated. | ||
* The **SVGAnimatedLength** interface represents attributes of type \<length> which can be animated. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGAnimatedLength) | ||
*/ | ||
|
@@ -20912,7 +20912,7 @@ declare var SVGAnimatedLengthList: { | |
}; | ||
|
||
/** | ||
* The SVGAnimatedNumber interface is used for attributes of basic type \ which can be animated. | ||
* The SVGAnimatedNumber interface is used for attributes of basic type \<Number> which can be animated. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGAnimatedNumber) | ||
*/ | ||
|
@@ -22107,7 +22107,7 @@ declare var SVGImageElement: { | |
}; | ||
|
||
/** | ||
* The **SVGLength** interface correspond to the \ basic data type. | ||
* The **SVGLength** interface correspond to the \<length> basic data type. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGLength) | ||
*/ | ||
|
@@ -22346,7 +22346,7 @@ declare var SVGMetadataElement: { | |
}; | ||
|
||
/** | ||
* The **SVGNumber** interface corresponds to the basic data type. | ||
* The **SVGNumber** interface corresponds to the <number> basic data type. | ||
* | ||
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGNumber) | ||
*/ | ||
|
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
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This lacks
<value>
incalc(1 / )
, that's tricky... maybe we should have a real markdown parser for that. I think that can be done in a followup and not necessarily here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have fixed it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We still lack backticks here, and in some markdown implementations lacking backticks may mean
<value>
won't be visible at all. (e.g. if it uses GFM)