docs: improve grammar #539
Open
Conversation
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
Author
|
@danwkennedy @yacaovsnc would it be possible to get a review on this? |
There was a problem hiding this comment.
Pull Request Overview
This PR improves grammar in the README documentation by fixing a sentence fragment and improving sentence flow in the "Overwriting an Artifact" section.
Key Changes
- Added missing subject "you" to fix incomplete sentence
- Changed sentence structure from two sentences to one compound sentence with "but" for better flow
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Overwriting an Artifact | ||
|
|
||
| Although it's not possible to mutate an Artifact, can completely overwrite one. But do note that this will give the Artifact a new ID, the previous one will no longer exist: | ||
| Although it's not possible to mutate an Artifact, you can completely overwrite one but do note that this will give the Artifact a new ID, the previous one will no longer exist: |
There was a problem hiding this comment.
[nitpick] The compound sentence is grammatically correct but quite long. Consider adding a comma before 'but' to improve readability: 'Although it's not possible to mutate an Artifact, you can completely overwrite one, but do note that this will give the Artifact a new ID, the previous one will no longer exist:'
Suggested change
| Although it's not possible to mutate an Artifact, you can completely overwrite one but do note that this will give the Artifact a new ID, the previous one will no longer exist: | |
| Although it's not possible to mutate an Artifact, you can completely overwrite one, but do note that this will give the Artifact a new ID, the previous one will no longer exist: |
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.