Walkthrough

Documentation comments were removed from six PyStr methods (removeprefix, removesuffix, format_map, title, isprintable, istitle) in the builtins module without modifying their implementations or behavior.

Changes

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• No functional logic changes; purely documentation removal
• Consistent pattern applied across multiple method declarations
• No risk of introducing bugs or altering behavior

Poem

A rabbit hops through comments old,
Where docs once spoke, now silence gold—
Six methods bare, their words now freed,
Simplicity is all we need! 🐰✨

Pre-merge checks and finishing touches

• 📝 Generate docstrings

• Create PR with unit tests
• Post copyable unit tests in a comment

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Reviewing files that changed from the base of the PR and between e096ce7 and 390f9f9.

• vm/src/builtins/str.rs (0 hunks)

• vm/src/builtins/str.rs

• GitHub Check: Check Rust code with rustfmt and clippy
• GitHub Check: Run snippets and cpython tests on wasm-wasi
• GitHub Check: Run snippets and cpython tests (windows-latest)
• GitHub Check: Run snippets and cpython tests (ubuntu-latest)
• GitHub Check: Check the WASM package and demo
• GitHub Check: Run rust tests (macos-latest)
• GitHub Check: Run snippets and cpython tests (macos-latest)
• GitHub Check: Run rust tests (windows-latest)
• GitHub Check: Run rust tests (ubuntu-latest)
• GitHub Check: Ensure compilation on various targets

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.

• X
• Mastodon
• Reddit
• LinkedIn

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

@ShaharNaveh I forgot what was the major reason to split it out. Probably the license and workflow part. To integrate it again, guidelines:

• Please check the generate script is still working well.
• The license must be aligned to CPython
• We'd better to generate them and commit from CI. (manual trigger when upgrading version)

@ShaharNaveh I forgot what was the major reason to split it out. Probably the license and workflow part. To integrate it again, guidelines:

• Please check the generate script is still working well.

I intend to refractor it, either way I'll make it will work.

• The license must be aligned to CPYTHON

Sure, will copy CPython license to crates/rustpython_doc_db/LICENSE

• We'd better to generate them and commit from CI. (manual trigger when upgrading version)

I thought of having the generate script to have a --check flag that will exit with non-zero on any diff, we will check it on the CI.

I thought of having the generate script to have a --check flag that will exit with non-zero on any diff, we will check it on the CI.

The current script is depends on python runtime. Each platform generate their own set of document. To cover the entire platform, the results from different platforms must be merged.

I thought of having the generate script to have a --check flag that will exit with non-zero on any diff, we will check it on the CI.

The current script is depends on python runtime. Each platform generate their own set of document. To cover the entire platform, the results from different platforms must be merged.

Make sense, I don't expect nt to be available on Linux. But I don't think that there's a difference between docstring of same object on different platforms, right? i.e, str.count is the same on Windows, Linux, MacOS. correct?

Yes, they are.