-
Notifications
You must be signed in to change notification settings - Fork 1
Fix fput_object typo in changelog #147
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.
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
base: master
Are you sure you want to change the base?
Conversation
📝 WalkthroughSummary by CodeRabbit
WalkthroughDocumentation fix: corrected a typo in the 1.1.0 changelog (method name changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (1)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
README.md(2 hunks)python/README.py.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
python/README.py.md
[grammar] ~165-~165: Use correct spacing
Context: ...put_object() rename arg: destination -> file_path ##### 1.0.1 - Added ShallowListing to _init...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
README.md
[grammar] ~165-~165: Use correct spacing
Context: ...put_object() rename arg: destination -> file_path ##### 1.0.1 - Added ShallowListing to _init...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🔇 Additional comments (1)
README.md (1)
79-79: Whitespace turbulence resolved.The sneaky trailing space after
bucket.move_prefix()is gone. Clean docs make for happy engineers.
|
|
||
| - IBucket rename: get_object_content() -> get_object() | ||
| - IBucket.fput_oject() rename arg: destination -> file_path | ||
| - IBucket.fput_object() rename arg: destination -> file_path |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Typo eliminated, clarity restored – nice.
fput_object() is now spelled correctly. Consider wrapping method and argument names in back-ticks ( IBucket.fput_object(), file_path ) to keep formatting consistent with the rest of the changelog, but otherwise this is ready for liftoff.
🧰 Tools
🪛 LanguageTool
[grammar] ~165-~165: Use correct spacing
Context: ...put_object() rename arg: destination -> file_path ##### 1.0.1 - Added ShallowListing to _init...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🤖 Prompt for AI Agents
In python/README.py.md at line 165, wrap the method name IBucket.fput_object()
and the argument file_path in back-ticks to maintain consistent formatting with
the rest of the changelog. This means enclosing them in `` to highlight them as
code elements.
|
|
||
| - IBucket rename: get_object_content() -> get_object() | ||
| - IBucket.fput_oject() rename arg: destination -> file_path | ||
| - IBucket.fput_object() rename arg: destination -> file_path |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Consistent nomenclature achieved.
The corrected bullet (fput_object() + file_path) aligns this README with the codebase. Same minor formatting nit as in the Python README: back-tick the identifiers for perfect consistency.
🧰 Tools
🪛 LanguageTool
[grammar] ~165-~165: Use correct spacing
Context: ...put_object() rename arg: destination -> file_path ##### 1.0.1 - Added ShallowListing to _init...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🤖 Prompt for AI Agents
In README.md at line 165, the argument name for IBucket.fput_object() was
changed from destination to file_path, but the identifiers are not back-ticked
for consistent formatting. Update the bullet point to enclose both fput_object()
and file_path in back-ticks to match the style used elsewhere in the README and
maintain consistent nomenclature formatting.
Summary
fput_objectTesting
pre-commit run --files README.md python/README.py.mdhttps://chatgpt.com/codex/tasks/task_e_688bf745e444832f9141f8877398af2b