Update README.md #136
Update README.md #136
Conversation
* typos and tweaks
|
Warning Rate limit exceeded@kghbln has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 41 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README.md file was revised to correct typographical and grammatical errors, update the minimum PHP version requirement to 8.1, adjust the Composer installation command to require version "~2.0", and standardize naming conventions and possessive forms. No functional or structural documentation changes were introduced. Changes
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
55-57: Use a single list marker for consistencyThe rest of the document uses dashes (
-) for unordered lists, while this block mixes in asterisks (*).
Sticking to one marker keeps the README tidy and silences MD004.-* [PHP] 8.1 or later (tested up to 8.4) -* [MediaWiki] 1.43 or later (tested up to 1.43) -* [Wikibase] 1.43 or later (tested up to 1.43) +- [PHP] 8.1 or later (tested up to 8.4) +- [MediaWiki] 1.43 or later (tested up to 1.43) +- [Wikibase] 1.43 or later (tested up to 1.43)
77-78: Tiny wording nit“wiki's Special:Version page” is technically correct but a bit clunky.
Consider “your wiki’s Special:Version page” (curly apostrophe) or simply “Special:Version”.
144-145: Bullet style mismatchSame MD004 issue as above. Switch to dashes for the release-notes list to stay uniform.
-* Raised minimum PHP version to 8.1 +- Raised minimum PHP version to 8.1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(6 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
55-55: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
56-56: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
144-144: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Psalm: MW REL1_43, PHP 8.3
🔇 Additional comments (2)
README.md (2)
12-15: Content update looks goodLink text, possessive form, and grammar improvements here read well and match the new reference label at the bottom. No further action needed.
62-66: Bump to ~2.0 Confirmed
Both checks pass:
- professional-wiki/wikibase-rdf v2.0.0 is published on Packagist.
composer.jsonin the repo root requires PHP >=8.1.You can safely update the README install command to use
~2.0.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
55-58: Standardize bullet style to satisfy markdownlint MD004Stars (
*) break the uniform list-style and trigger MD004 warnings. Switch to dashes to stay consistent with the rest of the document.-* [PHP] 8.1 or later (tested up to 8.4) -* [MediaWiki] 1.43 or later (tested up to 1.43) -* [Wikibase] 1.43 or later (tested up to 1.43) +- [PHP] 8.1 or later (tested up to 8.4) +- [MediaWiki] 1.43 or later (tested up to 1.43) +- [Wikibase] 1.43 or later (tested up to 1.43)
142-146: Keep list-style consistent in release notesSame MD004 issue here—dashes are used elsewhere in the file, so adopt them here as well.
-* Raised minimum MediaWiki version to 1.43 -* Raised minimum PHP version to 8.1 -* Translation updates for system messages (thanks @translatewiki and its translator community) +- Raised minimum MediaWiki version to 1.43 +- Raised minimum PHP version to 8.1 +- Translation updates for system messages (thanks @translatewiki and its translator community)
12-13: Optional: add an Oxford comma for clarityMinor style tweak—adding a serial comma avoids ambiguity in a three-item list.
-We provide [Wikibase hosting], [Wikibase development] and [Wikibase consulting]. +We provide [Wikibase hosting], [Wikibase development], and [Wikibase consulting].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(6 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
55-55: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
56-56: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
57-57: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
144-144: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
145-145: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
149-149: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
150-150: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Psalm: MW REL1_43, PHP 8.3
- GitHub Check: Psalm: MW REL1_43, PHP 8.3
work on nitpicks
Summary by CodeRabbit