orhan/test
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed documentation typos in _base_converter.py (#1393)

Browse Source
This commit is contained in:
JonahDelman
2025-08-26 17:23:10 -04:00
committed by GitHub
parent 9278119bb3
commit 1178c2e211
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/markitdown/src/markitdown/_base_converter.py
View File

@@ -69,7 +69,7 @@ class DocumentConverter:
data = file_stream.read(100) # ... peek at the first 100 bytes, etc. data = file_stream.read(100) # ... peek at the first 100 bytes, etc.
file_stream.seek(cur_pos) # Reset the position to the original position file_stream.seek(cur_pos) # Reset the position to the original position
Prameters: Parameters:
- file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods. - file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods.
- stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set) - stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set)
- kwargs: Additional keyword arguments for the converter. - kwargs: Additional keyword arguments for the converter.
@@ -90,7 +90,7 @@ class DocumentConverter:
""" """
Convert a document to Markdown text. Convert a document to Markdown text.
Prameters: Parameters:
- file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods. - file_stream: The file-like object to convert. Must support seek(), tell(), and read() methods.
- stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set) - stream_info: The StreamInfo object containing metadata about the file (mimetype, extension, charset, set)
- kwargs: Additional keyword arguments for the converter. - kwargs: Additional keyword arguments for the converter.