-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Replace line number reference with descriptive comment #51646
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: nohwnd <[email protected]>
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR addresses issue #51645 by replacing a line number reference in a comment with descriptive text, improving code maintainability. Line number references in comments become outdated and misleading as code evolves, making them problematic for future maintenance.
Key Changes:
- Updated comment in
NamedPipeServer.csto describe what the code is waiting for (InternalLoopAsync method exit after client disconnect) instead of referencing "line 103"
|
However, I omitted the URLs that link to a specific commit ID or tag. |
Co-authored-by: Copilot <[email protected]>
Comments referencing specific line numbers become misleading when code changes. Found and fixed one instance in the repository.
Change
src/Cli/dotnet/Commands/Test/MTP/IPC/NamedPipeServer.cs:239: Replaced"line 103"reference with descriptive textThe comment now describes what it's waiting for (the async loop method to exit after detecting client disconnect) rather than referencing a line number that could shift as code evolves.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.