Fix incomplete sentence and punctuation in README #508
Conversation
There was a problem hiding this comment.
Pull request overview
This PR attempts to fix what the author perceived as an incomplete sentence in the README's contribution guidelines. However, the change introduces a grammatical error rather than fixing one.
- The phrase "is organized by" is inserted into a previously correct sentence
- The original sentence was complete with a participial phrase that clearly explained the requirements
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| **3. Create a Pull Request (PR):** In your forked repository, develop the Python script and include a `README` file explaining how to use it. Ensure you credit the original contributor if you're building upon an existing script. | ||
|
|
||
| **4. Update the List:** If you're adding a new script, make sure to include it in the "List of Python Scripts" section below, providing a title, a link to the script's folder, and a brief description. | ||
| **4. Update the List:** If you're adding a new script, make sure to include it in the "List of Python Scripts" section below is organized by providing a title, a link to the script’s folder, and a brief description. |
There was a problem hiding this comment.
The added phrase "is organized by" creates a grammatically incorrect sentence. The original sentence was complete and correct - "providing a title..." was a participial phrase explaining how to include the script in the list. The new version reads: "...section below is organized by providing a title..." which is awkward and unclear.
Suggested fix: Revert to the original wording, or if reorganization is needed, consider: "...section below. Organize your entry by providing a title..."
| **4. Update the List:** If you're adding a new script, make sure to include it in the "List of Python Scripts" section below is organized by providing a title, a link to the script’s folder, and a brief description. | |
| **4. Update the List:** If you're adding a new script, make sure to include it in the "List of Python Scripts" section below. Organize your entry by providing a title, a link to the script’s folder, and a brief description. |
1 participant
This PR adds a missing verb and period to a sentence in the README file for clarity and correctness.