Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enriches the documentation by describing new async parsing defaults, lazy-loading support, and adds migration notes for version 0.36.0.
- Introduces a note on default asynchronous parsing and optional immediate parsing in README
- Documents lazy-loading large markdown via
LazyMarkdownSuccess - Adds Migration guide entries for Version 0.36.0
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Expanded usage examples: async vs. immediate parsing, lazy loading section, updated list handlers |
| MIGRATION.md | Added “Version 0.36.0” upgrade notes covering dependencies, breaking changes, and behavior changes |
Comments suppressed due to low confidence (3)
README.md:254
- Several lambda parameters (
type,index,listNumber,depth) are unused and may trigger warnings. Replace unused names with underscores (e.g.,{ _, bullet, _, _, _ -> }) to make it clear they are intentionally ignored.
CompositionLocalProvider(LocalBulletListHandler provides { type, bullet, index, listNumber, depth -> "$bullet " }) {
MIGRATION.md:3
- [nitpick] If there was a 0.35.0 release, consider including its notes or adding a comment that it was skipped to maintain a clear, sequential upgrade history.
#### Version 0.36.0
MIGRATION.md:6
- [nitpick] This list mixes verb tenses (imperative vs. past). For consistency, consider matching the tense of other items (e.g., “Removed all deprecated functions and fields”).
- **Breaking Change**: Remove all deprecated functions and fields
Comment on lines
+137
to
+140
| val markdownState = rememberMarkdownState(markdown) | ||
|
|
||
| // Force immediate parsing (not recommended) | ||
| val markdownState = rememberMarkdownState(markdown, immediate = true) |
There was a problem hiding this comment.
[nitpick] The snippet redeclares markdownState in the same code block, which would cause a redeclaration error if copied verbatim. Consider splitting it into separate code fences or using distinct variable names to avoid shadowing.
Suggested change
| val markdownState = rememberMarkdownState(markdown) | |
| // Force immediate parsing (not recommended) | |
| val markdownState = rememberMarkdownState(markdown, immediate = true) | |
| val markdownStateAsync = rememberMarkdownState(markdown) | |
| // Force immediate parsing (not recommended) | |
| val markdownStateImmediate = rememberMarkdownState(markdown, immediate = true) |
Comment on lines
+254
to
+259
| CompositionLocalProvider(LocalBulletListHandler provides { type, bullet, index, listNumber, depth -> "$bullet " }) { | ||
| Markdown(content) | ||
| } | ||
|
|
||
| // Replace the ordered list symbol with `A.)` instead. | ||
| CompositionLocalProvider(LocalOrderedListHandler provides { "A.) " }) { | ||
| CompositionLocalProvider(LocalOrderedListHandler provides { type, bullet, index, listNumber, depth -> "A.) " }) { |
There was a problem hiding this comment.
Unused lambda parameters (type, index, listNumber, depth) can be replaced with _ to avoid noise and clarify that only bullet is used.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Update readme
Fixes # (issue)
Type of change
Please delete options that are not relevant.