Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md file to improve the project description. The main change corrects the hyphenation of "Python-based" and attempts to add a repository reference with a badge/image link.
- Fixes grammar by adding hyphen to "Python-based"
- Adds text and image link referencing the GitHub repository
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #  PIVPy | ||
|
|
||
| Python based post-processing PIV data analysis | ||
| Python-based post-processing PIV data analysis in the repo: https://github.com/openpiv/pivpy |
There was a problem hiding this comment.
The added text "in the repo:" followed by a badge/image link is unclear and confusing. The phrase suggests the badge represents the repository itself, but the syntax used is for displaying an image/badge, not a standard link. Consider either:
- Using a proper markdown link: "Python-based post-processing PIV data analysis. See PIVPY"
- Or if this is meant to be a badge, ensure the URL points to an actual image resource, not the GitHub repository homepage
Suggested change
| Python-based post-processing PIV data analysis in the repo: https://github.com/openpiv/pivpy | |
| Python-based post-processing PIV data analysis. See [PIVPy](https://github.com/openpiv/pivpy). |
Owner
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.