[Documentation] Update comparison

[jan-janssen]

Summary by CodeRabbit

• Documentation
  • Updated comparison table column header from "Concurrent futures" to "Futures" for improved clarity across documentation.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates documentation to standardize naming conventions across comparison tables. The column header for the standard-library baseline executor is renamed from "Concurrent futures" to "Futures" in the README and the detailed comparison documentation, with a corresponding section heading update.

Changes

Documentation Terminology Update

Layer / File(s)	Summary
Rename "Concurrent futures" to "Futures" in comparison documentation README.md, docs/comparison.md	The "At a glance" comparison table header and matching section heading are updated to consistently use "Futures" instead of "Concurrent futures" for the standard-library baseline executor column.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny hops through docs with care,
Renaming labels, neat and fair—
"Futures" shines where once it sprawled,
Consistency achieved, all called! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title '[Documentation] Update comparison' is vague and generic, using non-descriptive terms that don't convey specific information about what was changed in the comparison documentation.	Consider a more specific title that describes the actual change, such as '[Documentation] Rename comparison table column from Concurrent futures to Futures'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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
• Commit unit tests in branch compare

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

155-155: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Update documentation index to match the renamed section.

The link text still says "Concurrent futures" and points to the old anchor #concurrent-futures-the-python-standard-library. Since the section heading in docs/comparison.md was renamed to "Futures" (line 25), this link should be updated for consistency.

📝 Proposed fix

-  * [Concurrent futures](https://executorlib.readthedocs.io/en/latest/comparison.html#concurrent-futures-the-python-standard-library)
+  * [Futures](https://executorlib.readthedocs.io/en/latest/comparison.html#futures)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 155, Update the README link that currently reads
"Concurrent futures" and points to the old anchor
`#concurrent-futures-the-python-standard-library` so it matches the renamed
section heading in docs/comparison.md ("Futures"); change the link text to
"Futures" and update the anchor to `#futures` so the reference resolves
correctly.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@README.md`:
- Line 155: Update the README link that currently reads "Concurrent futures" and
points to the old anchor `#concurrent-futures-the-python-standard-library` so it
matches the renamed section heading in docs/comparison.md ("Futures"); change
the link text to "Futures" and update the anchor to `#futures` so the reference
resolves correctly.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 788a7444-ffa8-4355-9ee3-ae779f0da017

📥 Commits

Reviewing files that changed from the base of the PR and between 19a0cce and db9148e.

📒 Files selected for processing (2)

• README.md
• docs/comparison.md

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.19%. Comparing base (19a0cce) to head (db9148e).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1009   +/-   ##
=======================================
  Coverage   94.19%   94.19%           
=======================================
  Files          39       39           
  Lines        2103     2103           
=======================================
  Hits         1981     1981           
  Misses        122      122           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.