Skip to content

fix(docs): correct typos found during code review #1482

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

Open
marcelpetrick wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): correct typos found during code review #1482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/markitdown-sample-plugin/src/markitdown_sample_plugin/_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def convert(
stream_info: StreamInfo,
**kwargs: Any,
) -> DocumentConverterResult:
# Read the file stream into an str using hte provided charset encoding, or using the system default
# Read the file stream into an str using the provided charset encoding, or using the system default
encoding = stream_info.charset or locale.getpreferredencoding()
stream_data = file_stream.read().decode(encoding)

Expand Down
2 changes: 1 addition & 1 deletion packages/markitdown-sample-plugin/tests/test_sample_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


def test_converter() -> None:
"""Tests the RTF converter dirctly."""
"""Tests the RTF converter directly."""
with open(os.path.join(TEST_FILES_DIR, "test.rtf"), "rb") as file_stream:
converter = RtfConverter()
result = converter.convert(
Expand Down
2 changes: 1 addition & 1 deletion packages/markitdown/src/markitdown/converters/_doc_intel_converter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ def accepts(
def _analysis_features(self, stream_info: StreamInfo) -> List[str]:
"""
Helper needed to determine which analysis features to use.
Certain document analysis features are not availiable for
Certain document analysis features are not available for
office filetypes (.xlsx, .pptx, .html, .docx)
"""
mimetype = (stream_info.mimetype or "").lower()
Expand Down
4 changes: 2 additions & 2 deletions packages/markitdown/tests/test_module_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def test_stream_info_operations() -> None:
**{keyword: f"{keyword}.2"}
)

# Make sure the targted attribute is updated
# Make sure the targeted attribute is updated
assert getattr(updated_stream_info, keyword) == f"{keyword}.2"

# Make sure the other attributes are unchanged
Expand All @@ -143,7 +143,7 @@ def test_stream_info_operations() -> None:
StreamInfo(**{keyword: f"{keyword}.2"})
)

# Make sure the targted attribute is updated
# Make sure the targeted attribute is updated
assert getattr(updated_stream_info, keyword) == f"{keyword}.2"

# Make sure the other attributes are unchanged
Expand Down