Skip to content
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

Update runner.md to catch runner structure change. #37515

Merged
merged 1 commit into from
Feb 19, 2025

Conversation

vanzue
Copy link
Contributor

@vanzue vanzue commented Feb 18, 2025

Update runner documentation to reflect newest code structure

PR Checklist

  • Closes: #xxx
  • Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • Tests: Added/updated and all pass
  • Localization: All end user facing strings can be localized
  • Dev docs: Added/updated
  • New binaries: Added on the required places
  • Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

runner.md file is out of date, update them to reflect newest code structure

The runner documentation is out of date, powertoys_events.cpp,lowlevel_keyboard_event.cpp, win_hook_event.cpp
does not exist any more, and make simple document for newly added files for their functionality.

@vanzue vanzue requested a review from Copilot February 18, 2025 10:05
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment on lines 42 to 43
Contains codes for restart a process.

Copy link
Preview

Copilot AI Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase 'Contains codes for restart a process' is grammatically incorrect. It should be 'Contains code for restarting a process.'

Suggested change
Contains codes for restart a process.
Contains code for restarting a process.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
Contains logic that periodically triggers module-specific setting's telemetry delivery and manages timing and error handling for the process.

#### [`UpdateUtils.cpp`](/src/runner/UpdateUtils.cpp)
Contains code to handle the automatic update checking, notification, and installation process for PowerToys, including functions for periodic update checks, manual update checks, and displaying notifications to the user about new versions.
Copy link
Preview

Copilot AI Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The sentence is too wordy and could be clearer. Consider breaking it down into simpler sentences for better readability.

Suggested change
Contains code to handle the automatic update checking, notification, and installation process for PowerToys, including functions for periodic update checks, manual update checks, and displaying notifications to the user about new versions.
Contains code to handle the automatic update checking, notification, and installation process for PowerToys. It includes functions for periodic update checks and manual update checks. It also displays notifications to the user about new versions.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options

This comment has been minimized.

@vanzue vanzue force-pushed the user/vanzue/update-runner-doc branch from 30bba33 to 798e099 Compare February 18, 2025 11:07
@vanzue vanzue requested a review from Copilot February 18, 2025 11:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

@vanzue
Copy link
Contributor Author

vanzue commented Feb 18, 2025

@microsoft-github-policy-service agree [company="{microsoft}"]

@vanzue vanzue requested review from a team and jaimecbernardo and removed request for jaimecbernardo and a team February 18, 2025 13:50
Copy link
Contributor

@shuaiyuanxx shuaiyuanxx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@vanzue vanzue merged commit 9d148d0 into main Feb 19, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants