Adding JSDocs for all public symbols #823
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
Tagging OptionsShould a new tag be published when this PR is merged?
|
mcandeia
requested changes
Sep 10, 2024
blocks/page.tsx
Outdated
| @@ -6,6 +6,17 @@ import { createSectionBlock, type SectionModule } from "./section.ts"; | |||
|
|
|||
| export type Page = InstanceOf<typeof page, "#/root/pages">; | |||
|
|
|||
| /** | |||
| * Creates a new Block object for a section within a component or page. | |||
There was a problem hiding this comment.
Suggested change
| * Creates a new Block object for a section within a component or page. | |
| * Defines a Page block. Pages are JSX-based components and can be rendered by any JSX-compliant library like react or preact. |
blocks/utils.tsx
Outdated
| }; | ||
| /** | ||
| * Applies props to a function and returns the result. |
There was a problem hiding this comment.
Suggested change
| * Applies props to a function and returns the result. | |
| * Applies the given props to the target block function. |
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.
Creating good documentation for functions and symbols using JSDocs.
Issue: #815