Skip to content

Commit

Permalink
Bump typedoc and typedoc-plugin-markdown (#4319)
Browse files Browse the repository at this point in the history
* Bump typedoc and typedoc-plugin-markdown

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) and [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown). These dependencies needed to be updated together.

Updates `typedoc` from 0.25.13 to 0.26.2
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.13...v0.26.2)

Updates `typedoc-plugin-markdown` from 4.0.3 to 4.1.0
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/[email protected]/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
- dependency-name: typedoc-plugin-markdown
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Update typedoc-plugin-missing-exports as well

* Fix docs generation

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Harel M <[email protected]>
  • Loading branch information
dependabot[bot] and HarelM authored Jun 26, 2024
1 parent 57d829b commit f1b6079
Show file tree
Hide file tree
Showing 5 changed files with 98 additions and 71 deletions.
2 changes: 1 addition & 1 deletion build/generate-struct-arrays.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ function emitStructArrayLayout(locals) {

for (const member of members) {
output.push(
` * [${member.offset}]: ${member.type}[${member.components}]`);
` * [${member.offset}] - ${member.type}[${member.components}]`);
}

output.push(
Expand Down
155 changes: 91 additions & 64 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@
"ts-jest": "^29.1.5",
"ts-node": "^10.9.2",
"tslib": "^2.6.3",
"typedoc": "^0.25.13",
"typedoc-plugin-markdown": "^4.0.3",
"typedoc-plugin-missing-exports": "^2.3.0",
"typedoc": "^0.26.2",
"typedoc-plugin-markdown": "^4.1.0",
"typedoc-plugin-missing-exports": "^3.0.0",
"typescript": "^5.4.5"
},
"overrides": {
Expand Down
2 changes: 1 addition & 1 deletion src/source/source.ts
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ const setSourceType = (name: string, type: SourceClass) => {
/**
* Adds a custom source type, making it available for use with {@link Map#addSource}.
* @param name - The name of the source type; source definition objects use this name in the `{type: ...}` field.
* @param sourceType - A {@link SourceClass} - which is a constructor for the `Source` interface.
* @param SourceType - A {@link SourceClass} - which is a constructor for the `Source` interface.
* @returns a promise that is resolved when the source type is ready or rejected with an error.
*/
export const addSourceType = async (name: string, SourceType: SourceClass): Promise<void> => {
Expand Down
4 changes: 2 additions & 2 deletions src/style/style.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ export type StyleSetterOptions = {
* when a desired style is a certain combination of previous and incoming style
* when an incoming style requires modification based on external state
*
* @param previousStyle - The current style.
* @param nextStyle - The next style.
* @param previous - The current style.
* @param next - The next style.
* @returns resulting style that will to be applied to the map
*
* @example
Expand Down

0 comments on commit f1b6079

Please sign in to comment.