Skip to content

docs: fix duplicate "mode mode" word in crewai-files docstrings#5968

Open
kratos0718 wants to merge 1 commit into
crewAIInc:mainfrom
kratos0718:docs/fix-duplicate-mode-typos
Open

docs: fix duplicate "mode mode" word in crewai-files docstrings#5968
kratos0718 wants to merge 1 commit into
crewAIInc:mainfrom
kratos0718:docs/fix-duplicate-mode-typos

Conversation

@kratos0718
Copy link
Copy Markdown

@kratos0718 kratos0718 commented May 29, 2026

Summary

Fixed 8 instances of the accidental duplicate word mode mode across the crewai-files package and its tests. All occurrences were in docstrings (class/method documentation and test descriptions) — pure text fixes, no behavior change.

Files changed

File Occurrences
lib/crewai-files/src/crewai_files/core/types.py 1 (in BaseFile class docstring)
lib/crewai-files/src/crewai_files/processing/processor.py 5 (FileProcessor class, _get_mode, process docstrings)
lib/crewai/tests/utilities/test_files.py 2 (test_file_custom_mode, test_file_chunk_mode docstrings)

Example

Before:

class FileProcessor:
    """Processes files according to provider constraints and per-file mode mode."""


<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

* **Documentation**
  * Corrected duplicated text in internal code documentation to improve clarity and accuracy.

<!-- review_stack_entry_start -->

[![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/crewAIInc/crewAI/pull/5968?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

<!-- review_stack_entry_end -->

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Fixed 8 accidental "mode mode" duplicate-word typos across 3 files,
all in docstrings (class/method documentation and test descriptions):

- crewai_files/core/types.py — BaseFile class docstring
- crewai_files/processing/processor.py — FileProcessor class and methods
  (_get_mode, process docstrings)
- tests/utilities/test_files.py — test_file_custom_mode and
  test_file_chunk_mode docstrings

Pure docstring fixes — no behavior change.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 91625c12-a17a-45f5-a4ae-4f8243a1c863

📥 Commits

Reviewing files that changed from the base of the PR and between fca21b1 and d682e2a.

📒 Files selected for processing (3)
  • lib/crewai-files/src/crewai_files/core/types.py
  • lib/crewai-files/src/crewai_files/processing/processor.py
  • lib/crewai/tests/utilities/test_files.py

📝 Walkthrough

Walkthrough

This PR corrects duplicated wording in docstrings across the crewAI file processing components. Erroneous word repetitions ("mode mode", "Per-file mode mode mode") are removed from the BaseFile class, FileProcessor class and methods, and from file mode test docstrings. No functional logic or test behavior was altered.

Changes

Documentation cleanup

Layer / File(s) Summary
Docstring corrections for file mode documentation
lib/crewai-files/src/crewai_files/core/types.py, lib/crewai-files/src/crewai_files/processing/processor.py, lib/crewai/tests/utilities/test_files.py
Removes duplicated wording ("mode mode", "Per-file mode mode mode") from docstrings in BaseFile, FileProcessor class and method descriptions, and mode-related test functions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A docstring fix, so clean and neat,
Removed the words that did repeat,
"Mode mode mode" now just "mode" stands tall,
The tidiest cleanup of all!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing duplicate 'mode mode' words in crewai-files docstrings, which aligns with all file modifications.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant