Open
Conversation
Contributor
There was a problem hiding this comment.
Caution
Changes requested ❌
Reviewed everything up to 737cd08 in 1 minute and 37 seconds. Click for details.
- Reviewed
116lines of code in1files - Skipped
0files when reviewing. - Skipped posting
6draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. terminal/answers/angi.md:8
- Draft comment:
Use straight quotes or backticks instead of typographic quotes in the usage example to improve copy-paste compatibility. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 30% vs. threshold = 50% This is a valid point about command line usage - typographic quotes won't work if copy-pasted into a terminal. However, this is just documentation in a markdown file, not actual code. The quotes are being used as placeholders in example paths, not as actual commands meant to be copy-pasted. The current format is clear enough for learning purposes. The comment identifies a real technical issue - typographic quotes don't work in terminals. Someone might try to copy-paste these examples. While technically correct, this is a minor formatting issue in documentation where the quotes are clearly just placeholders. The educational value is not significantly impacted. This comment, while technically accurate, suggests a minor formatting change that doesn't meaningfully impact the educational value of the documentation. The comment should be removed.
2. terminal/answers/angi.md:40
- Draft comment:
Fix mismatched quotation marks in the 'rm -R' usage example by using consistent straight quotes. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While technically correct that the quotes are inconsistent, this is a minor formatting issue in a markdown documentation file. The quotes would work either way in actual terminal usage. This seems like an overly pedantic comment that doesn't affect functionality or readability significantly. The inconsistent quotes could potentially confuse readers who are copy-pasting commands, or it could indicate poor attention to detail in the documentation. The difference between straight and curly quotes is minor enough that most users would understand the intent, and the command would work either way in a real terminal. This comment is too minor and doesn't point out a significant enough issue to warrant attention in code review.
3. terminal/answers/angi.md:59
- Draft comment:
Typo: Change 'gget' to 'get' in the ditto command description. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically a correct observation of a typo, our rules state we should not make purely informative comments or comments about obvious issues. A simple typo like this is very minor and doesn't affect code functionality since this is just documentation. The author will likely notice and fix it themselves during review. The typo could potentially confuse readers of the documentation. Documentation accuracy is important for learning materials. While documentation accuracy matters, this particular typo is so obvious that any reader would understand the intended meaning. It doesn't warrant a formal comment in the PR review. This comment should be removed as it points out an extremely minor typo that doesn't impact functionality and violates our rule about not making purely informative comments about obvious issues.
4. terminal/answers/angi.md:109
- Draft comment:
Add a newline at the end of the file for better POSIX compliance and readability. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% While having a newline at the end of files is a common convention and good practice, this is a very minor issue. The file will still work perfectly fine without it. This seems like the kind of minor issue that would be better handled by an automated formatter or linter rather than a PR comment. It doesn't affect functionality and isn't a significant code quality issue. The comment is technically correct and follows good POSIX practices. Missing newlines can cause issues with some tools. While technically valid, this is too minor of an issue to warrant a manual PR comment. This should be handled by automation instead. Delete this comment as it's too minor of an issue to warrant manual review attention.
5. terminal/answers/angi.md:6
- Draft comment:
Consider using inline code formatting (e.g., using backticks) for command names and paths to enhance readability. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
6. terminal/answers/angi.md:40
- Draft comment:
Inconsistent quotation marks: the command uses an opening curly quote ( “ ) and a closing straight quote ("). Consider using consistent quotation marks. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% This is a documentation file explaining CLI commands. While the inconsistent quotes are real, they don't affect the functionality of the command - both curly and straight quotes would work the same way in a terminal. The comment is more about formatting consistency than a real code issue. Looking at other examples in the file, they use straight quotes consistently. The inconsistency could potentially confuse readers who are copying and pasting commands. It's also part of maintaining consistent documentation style. However, this is a minor formatting issue in a markdown documentation file, not a critical code change. The rules state not to make comments that are obvious or unimportant. This comment should be deleted as it points out a minor formatting inconsistency that doesn't affect functionality and isn't important enough to warrant a PR comment.
Workflow ID: wflow_ozsXtNXRxE9ZEEUX
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
| - usage: clear, or cmd-K | ||
|
|
||
| 14. ditto | ||
| - copy contents of one folder to another folder, can use -V to gget verbose output for each file copied |
Contributor
There was a problem hiding this comment.
Typo found: "gget" should be corrected to "get" in this line.
Suggested change
| - copy contents of one folder to another folder, can use -V to gget verbose output for each file copied | |
| - copy contents of one folder to another folder, can use -V to get verbose output for each file copied |
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
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.
Important
Adds
angi.mdwith explanations of top 20 mac CLI commands, terminal-related concepts, and differences betweenbashandzsh.angi.mdtoterminal/answers/with explanations of top 20 mac CLI commands includingcd,ls,open,cp,mv,touch,mkdir,rmdir,rm -R,sudo,top,q,clear,ditto,whatis,man,exit,shortcuts run,tmutil startbackup,killall.bashandzshshells.This description was created by
for 737cd08. You can customize this summary. It will automatically update as commits are pushed.