Skip to content

Chore: readme grammar updates#360

Closed
Zipbug wants to merge 3 commits intokavishdevar:mainfrom
Zipbug:readme-grammar-updates
Closed

Chore: readme grammar updates#360
Zipbug wants to merge 3 commits intokavishdevar:mainfrom
Zipbug:readme-grammar-updates

Conversation

@Zipbug
Copy link
Copy Markdown

@Zipbug Zipbug commented Dec 7, 2025

In the readme, there are a few grammar and spelling fixes that should be addressed.

Line 12, heartrate should be heart rate

Line 16 should be:

Most features should work with any version of AirPods. Currently, I only have AirPods Pro 2 available for testing; however, I believe the protocol remains the same for all other models based on my analysis of the Bluetooth stack on macOS.

Line 27 and 81, upto should be up to

Line 72, there are two uses of overlayfs, which should be overlays

Summary by CodeRabbit

  • Documentation
    • Improved README readability and grammar, including corrected technical terms (e.g., “heart rate” and “up to”), punctuation, and phrasing.
    • Reworded device, feature, and platform notes for consistency and formality.
    • Standardized capitalization, hyphenation, and minor formatting for clearer guidance.
    • No functional changes to code, public APIs, or exported interfaces.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Dec 7, 2025

Walkthrough

The PR updates README.md with grammar, spelling, hyphenation, capitalization, punctuation, and phrasing fixes (e.g., "heartrate" → "heart rate", "upto" → "up to", "long press" → "long-press"), and clarifies several feature and platform-specific notes. No code or public API changes.

Changes

Cohort / File(s) Summary
Documentation corrections
README.md
Revised wording and phrasing, fixed typos and spacing, standardized hyphenation/capitalization/punctuation, and clarified feature and platform notes. No functional, code, or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Quick pass to verify textual edits; focus on consistency and no accidental code block or formatting changes.

Possibly related issues

Poem

🐰 I hopped through lines to mend,
commas tucked and phrases penned,
"Up to" pranced, hyphens snug and tight,
readme gleamed in morning light,
a tiny hop — docs just right.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Chore: readme grammar updates' directly and clearly describes the main change in the PR—grammar and spelling fixes to the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a 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: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e1f784 and d3910fd.

📒 Files selected for processing (1)
  • README.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~71-~71: Ensure spelling is correct
Context: ...igures out a fix. Until then, you must xposed. I used to provide a non-xposed method ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (1)
README.md (1)

16-16: Grammar and spelling corrections look good.

The updates to Line 16 (testing statement), Line 27 (multi-device connectivity phrasing), and Line 81 (connecting devices) all correctly apply "up to" (two words) and improve clarity per the PR objectives.

Also applies to: 27-27, 81-81

Comment thread README.md Outdated
Comment thread README.md Outdated
> There are **no exceptions** to the root requirement until Google/your OEM figures out a fix.

Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlayfs to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlayfs and a patched library. With xposed, you can also enable the DID hook enabling a few extra features.
Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook enabling a few extra features.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the incomplete phrase on Line 71.

"You must xposed" is grammatically incorrect and incomplete. It should be "you must use xposed" or similar.

Apply this fix:

-Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library.
+Until then, you must use xposed. I used to provide a non-xposed method too, where the module used overlays to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook enabling a few extra features.
Until then, you must use xposed. I used to provide a non-xposed method too, where the module used overlays to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook enabling a few extra features.
🧰 Tools
🪛 LanguageTool

[grammar] ~71-~71: Ensure spelling is correct
Context: ...igures out a fix. Until then, you must xposed. I used to provide a non-xposed method ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In README.md around line 71, the sentence "Until then, you must xposed." is
grammatically incorrect and incomplete; replace it with a corrected phrase such
as "Until then, you must use Xposed." or "Until then, you must have Xposed
installed." so the sentence reads clearly (also capitalize "Xposed"
consistently) and ensure the rest of the paragraph flows with the updated
wording.

Grammar and spelling fixes.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a 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

♻️ Duplicate comments (1)
README.md (1)

71-71: Critical: Fix the incomplete grammar on Line 71.

"You must xposed" is grammatically incorrect and incomplete. This issue was flagged in past reviews but remains unresolved. It should be "you must use xposed" or similar.

Apply this fix:

-Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the Bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook, enabling a few extra features.
+Until then, you must use xposed. I used to provide a non-xposed method too, where the module used overlays to replace the Bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook, enabling a few extra features.
🧹 Nitpick comments (1)
README.md (1)

39-39: Optional: Improve professional tone on Line 39.

The phrase "the maintainer didn't have time to work on it" is informal. Consider using more professional phrasing such as: "the maintainer had limited availability to maintain it" or "development was paused due to resource constraints."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d3910fd and 04790d8.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~26-~26: Do not mix variants of the same word (‘customize’ and ‘customise’) within a single text.
Context: ... when you speak - Hearing Aid* - Customize Transparency Mode* - **Multi-device ...

(EN_WORD_COHERENCY)


[style] ~39-~39: To elevate your writing and sound more professional, you can use different wording here.
Context: ...ny features; the maintainer didn't have time to work on it) new version in developm...

(DIDNT_HAVE_THE_TIME)


[grammar] ~71-~71: Ensure spelling is correct
Context: ...igures out a fix. Until then, you must xposed. I used to provide a non-xposed method ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
README.md

60-60: Bare URL used

(MD034, no-bare-urls)

Comment thread README.md Outdated
Comment thread README.md
PR feedback, cleanup `customizations` so it's consistent
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
README.md (1)

71-71: Unresolved: fix grammatical error "you must xposed"—should be "you must use xposed".

This critical grammar issue was flagged in a previous review but remains unfixed. The phrase "Until then, you must xposed." is incomplete and grammatically incorrect. It should read "Until then, you must use xposed." or a similar complete phrase.

Apply this fix:

-Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the Bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook, enabling a few extra features.
+Until then, you must use xposed. I used to provide a non-xposed method too, where the module used overlays to replace the Bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook, enabling a few extra features.
🧹 Nitpick comments (2)
README.md (2)

39-39: Consider rephrasing for a more professional tone.

The phrase "didn't have time to work on it" could be elevated for consistency with the rest of the README's formal voice. Consider a more professional alternative.

Suggested improvement:

-For the old version, see the [Linux README](./linux/README.md). (doesn't have many features; the maintainer didn't have time to work on it)
+For the old version, see the [Linux README](./linux/README.md). (lacks many features due to bandwidth constraints of the maintainer)

60-60: Replace bare URL with markdown link syntax.

Line 60 contains a bare URL without markdown link syntax, which violates the MD034 (no-bare-urls) rule from markdownlint.

Wrap the URL in a markdown link:

-Here's a very unprofessional demo video
-
-https://github.com/user-attachments/assets/43911243-0576-4093-8c55-89c1db5ea533
+Here's a very unprofessional demo video:
+
+[Demo Video](https://github.com/user-attachments/assets/43911243-0576-4093-8c55-89c1db5ea533)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04790d8 and 069a49e.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[style] ~39-~39: To elevate your writing and sound more professional, you can use different wording here.
Context: ...ny features; the maintainer didn't have time to work on it) new version in developm...

(DIDNT_HAVE_THE_TIME)


[grammar] ~71-~71: Ensure spelling is correct
Context: ...igures out a fix. Until then, you must xposed. I used to provide a non-xposed method ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
README.md

60-60: Bare URL used

(MD034, no-bare-urls)

Comment thread README.md
> There are **no exceptions** to the root requirement until Google/your OEM figures out a fix.

Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlayfs to replace the bluetooth library with a locally patched one, but that was broken due to how various devices handled overlayfs and a patched library. With xposed, you can also enable the DID hook enabling a few extra features.
Until then, you must xposed. I used to provide a non-xposed method too, where the module used overlays to replace the Bluetooth library with a locally patched one, but that was broken due to how various devices handled overlays and a patched library. With xposed, you can also enable the DID hook, enabling a few extra features.
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is supposed to be overlayfs.

Comment thread README.md
- Due to recent AirPods' firmware upgrades, you must enable `Off listening mode` to switch to `Off`. This is because in this mode, loud sounds are not reduced.

- If you have take both AirPods out, the app will automatically switch to the phone speaker. But, Android might keep on trying to connect to the AirPods because the phone is still connected to them, just the A2DP profile is not connected. The app tries to disconnect the A2DP profile as soon as it detects that Android has connected again if they're not in the ear.
- If you have to take both AirPods out, the app will automatically switch to the phone speaker. However, Android might keep on trying to connect to the AirPods because the phone is still connected to them, just the A2DP profile is not connected. The app tries to disconnect the A2DP profile as soon as it detects that Android has connected again if they're not in the ear.
Copy link
Copy Markdown
Owner

@kavishdevar kavishdevar Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have taken. If you have to take [...] the app will... doesn't make sense

@Zipbug Zipbug closed this Dec 11, 2025
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.

2 participants