Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve doc gen #1038

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Improve doc gen #1038

merged 1 commit into from
Dec 3, 2024

Conversation

Ocupe
Copy link
Contributor

@Ocupe Ocupe commented Dec 2, 2024

  • Inline deprecation warning to improve rendering.

@Ocupe Ocupe requested a review from lukasIO December 2, 2024 10:53
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 2, 2024

⚠️ No Changeset found

Latest commit: e0ab670

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 2, 2024

size-limit report 📦

Path Size
LiveKitRoom only 6 KB (0%)
LiveKitRoom with VideoConference 29.76 KB (0%)
All exports 36.6 KB (0%)

@Ocupe Ocupe marked this pull request as ready for review December 2, 2024 13:58
lukasIO
lukasIO reviewed Dec 2, 2024
View reviewed changes
tooling/api-documenter/src/documenters/MarkdownDocumenter.ts
if (!addedDeprecationString && node.kind === DocNodeKind.Paragraph) {
const paragraphChildren = node
.getChildNodes()
.reduce<DocNode[]>((paragraphNodes, paraNode) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this omitting some elements? reduce vs map always makes me expect a non equivalent number of items being returned, same question above in L230

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is expected to return the same number of elements. I used reduce to iterate over the nodes and once we update the first Plain Text node we skip the first code branch and just push the elements onto the array.

@Ocupe Ocupe merged commit 9e055f0 into main Dec 3, 2024
3 checks passed
@Ocupe Ocupe deleted the fix-deprecated-block-docs-generation branch December 3, 2024 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukasIO lukasIO lukasIO approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Ocupe @lukasIO