Skip to content

README.md: Restore line feeds in Screenshots section#3521

Merged
acicovic merged 1 commit intodevelopfrom
fix/restore-line-feeds-in-sceenshots-section-in-readme-md
Jul 3, 2025
Merged

README.md: Restore line feeds in Screenshots section#3521
acicovic merged 1 commit intodevelopfrom
fix/restore-line-feeds-in-sceenshots-section-in-readme-md

Conversation

@acicovic
Copy link
Collaborator

@acicovic acicovic commented Jul 3, 2025

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 the Screenshots section. 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

  • Documentation
    • Improved formatting in the "Screenshots" section of the README for consistent line breaks.

@acicovic acicovic added this to the 3.20.4 milestone Jul 3, 2025
@acicovic acicovic self-assigned this Jul 3, 2025
@acicovic acicovic requested a review from a team as a code owner July 3, 2025 13:50
@acicovic acicovic added the Maintenance & Fixes Ticket/PR related to codebase maintenance tasks label Jul 3, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 3, 2025

📝 Walkthrough

Walkthrough

Trailing 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

File(s) Change Summary
README.md Added trailing double spaces to screenshot description lines 1–10 for consistent Markdown line breaks.

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between 494fd00 and 22d9fb1.

📒 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-breaks

The 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.

@acicovic acicovic merged commit 4efe9fd into develop Jul 3, 2025
19 checks passed
@acicovic acicovic deleted the fix/restore-line-feeds-in-sceenshots-section-in-readme-md branch July 3, 2025 13:58
github-actions bot added a commit that referenced this pull request Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintenance & Fixes Ticket/PR related to codebase maintenance tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant