docs: use canonical markdown result property - #2259
Merged
afourney merged 2 commits intoSep 2, 2026
Merged
Conversation
Yasir Hassan (sirrryasir)
approved these changes
Jul 30, 2026
Yasir Hassan (sirrryasir)
left a comment
Yasir Hassan (sirrryasir)
left a comment
There was a problem hiding this comment.
Great catch! Updating the documentation to reflect the canonical markdown property makes it much clearer for new users. The changes look perfect.
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only updates are consistent and have no unresolved issues.
Pull request overview
Updates documentation examples to use the canonical DocumentConverterResult.markdown property.
Changes:
- Replaces deprecated
result.text_contentusage. - Aligns top-level and package README examples.
File summaries
| File | Description |
|---|---|
README.md |
Updates Python conversion examples to use result.markdown. |
packages/markitdown/README.md |
Aligns the package example with the canonical API. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
result.markdowninstead of the soft-deprecatedresult.text_contentaliasDocumentConverterResultAPIVerification
rg "result\.text_content|text_content" README.md packages/markitdown/README.md; test 0 -eq 1rg "result\.markdown" README.md packages/markitdown/README.md -nNote: a local import smoke test with
python3was blocked because this environment does not have the package dependencymagikainstalled.