README.md: Restore line feeds in Screenshots section#3521
Conversation
📝 WalkthroughWalkthroughTrailing double spaces were added to the end of each numbered screenshot description line in the "Screenshots" section of the README.md file. This change standardizes Markdown formatting for line breaks before the associated images. No other content or files were modified. Changes
Sequence Diagram(s)(No sequence diagram is necessary for this change.) 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
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
130-130: Nit: add a comma after the introductory “Also” for smoother flow-8. The Parse.ly Excerpt Suggestions in the Post Editor's settings. Also available in the Parse.ly Editor Sidebar. +8. The Parse.ly Excerpt Suggestions in the Post Editor's settings. Also, available in the Parse.ly Editor Sidebar.Purely stylistic; feel free to ignore if you’d rather keep the original wording.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-10-16T13:03:58.056Z
Learning: User: acicovic
URL: https://github.com/Parsely/wp-parsely/pull/2355
Timestamp: 2024-04-03T08:04:35.576Z
Learning: In the context of the `wp-parsely` project's documentation, bullet points are consistently capitalized. This standard should be respected in reviews and suggestions regarding document formatting.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-07-26T21:07:21.167Z
Learning: User: acicovic
URL: https://github.com/Parsely/wp-parsely/pull/2355
Timestamp: 2024-04-03T08:04:35.576Z
Learning: In the context of the `wp-parsely` project's documentation, bullet points are consistently capitalized. This standard should be respected in reviews and suggestions regarding document formatting.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-10-16T13:03:58.056Z
Learning: The "Tested up to:" line in the `README.md` file of WordPress plugins follows a specific format as per the WordPress.org documentation and should not be altered based on grammatical considerations.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-07-26T21:07:21.167Z
Learning: The "Tested up to:" line in the `README.md` file of WordPress plugins follows a specific format as per the WordPress.org documentation and should not be altered based on grammatical considerations.
Learnt from: acicovic
PR: Parsely/wp-parsely#2350
File: README.md:0-0
Timestamp: 2024-07-26T21:07:21.167Z
Learning: The README.md file of WordPress plugins follows a specific header format as specified by the WordPress.org documentation. This format is not meant to be grammatically correct sentences but adheres to a structure required by WordPress.org.
Learnt from: acicovic
PR: Parsely/wp-parsely#2350
File: README.md:0-0
Timestamp: 2024-10-09T01:44:15.345Z
Learning: The README.md file of WordPress plugins follows a specific header format as specified by the WordPress.org documentation. This format is not meant to be grammatically correct sentences but adheres to a structure required by WordPress.org.
Learnt from: acicovic
PR: Parsely/wp-parsely#2350
File: README.md:0-0
Timestamp: 2024-10-16T13:03:58.056Z
Learning: The README.md file of WordPress plugins follows a specific header format as specified by the WordPress.org documentation. This format is not meant to be grammatically correct sentences but adheres to a structure required by WordPress.org.
Learnt from: acicovic
PR: Parsely/wp-parsely#2554
File: src/UI/class-settings-page.php:28-29
Timestamp: 2024-06-18T09:33:19.519Z
Learning: acicovic prefers to use the term "resolve" to indicate that an issue or request has been addressed satisfactorily.
Learnt from: acicovic
PR: Parsely/wp-parsely#2554
File: src/UI/class-settings-page.php:28-29
Timestamp: 2024-10-12T10:01:08.699Z
Learning: acicovic prefers to use the term "resolve" to indicate that an issue or request has been addressed satisfactorily.
README.md (4)
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-10-16T13:03:58.056Z
Learning: User: acicovic
URL: https://github.com/Parsely/wp-parsely/pull/2355
Timestamp: 2024-04-03T08:04:35.576Z
Learning: In the context of the `wp-parsely` project's documentation, bullet points are consistently capitalized. This standard should be respected in reviews and suggestions regarding document formatting.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-07-26T21:07:21.167Z
Learning: User: acicovic
URL: https://github.com/Parsely/wp-parsely/pull/2355
Timestamp: 2024-04-03T08:04:35.576Z
Learning: In the context of the `wp-parsely` project's documentation, bullet points are consistently capitalized. This standard should be respected in reviews and suggestions regarding document formatting.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-10-16T13:03:58.056Z
Learning: The "Tested up to:" line in the `README.md` file of WordPress plugins follows a specific format as per the WordPress.org documentation and should not be altered based on grammatical considerations.
Learnt from: acicovic
PR: Parsely/wp-parsely#0
File: :0-0
Timestamp: 2024-07-26T21:07:21.167Z
Learning: The "Tested up to:" line in the `README.md` file of WordPress plugins follows a specific format as per the WordPress.org documentation and should not be altered based on grammatical considerations.
🪛 LanguageTool
README.md
[uncategorized] ~130-~130: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...gestions in the Post Editor's settings. Also available in the Parse.ly Editor Sideba...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: E2E against WordPress latest
🔇 Additional comments (1)
README.md (1)
116-135: Trailing spaces successfully reinstate the intended line-breaksThe two spaces you’ve appended at the end of each numbered description restore the Markdown soft-break that WordPress.org trims without them. Rendering now matches the pre-#3485 layout.
…n-sceenshots-section-in-readme-md" (4efe9fd)
Description
In #3485, some line feeds (in form of double spaces) were mistakenly removed from our
README.md. This PR restores the line feeds under theScreenshotssection. Although the removal didn't seem to have any unwanted side-effects looking at our plugin page, I still prefer to have the line feeds explicitly there.How has this been tested?
Checked that the file renders correctly in VSCode's Markdown preview.
Summary by CodeRabbit