fix: misplaced doc comment and section numbering after refactor#144
Merged
HiGarfield merged 2 commits intomasterfrom Mar 20, 2026
Merged
fix: misplaced doc comment and section numbering after refactor#144HiGarfield merged 2 commits intomasterfrom
HiGarfield merged 2 commits intomasterfrom
Conversation
The documentation comment for run_pid_or_exe_mode() was placed before report_process_not_found() instead of directly above its own function definition. Move it to the correct position. Co-authored-by: HiGarfield <32226909+HiGarfield@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix bugs and improve comments after major refactor
fix: misplaced doc comment and section numbering after refactor
Mar 20, 2026
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
This PR fixes two cosmetic/structural issues introduced by a recent refactor: a misplaced Doxygen doc comment in src/limiter.c and incorrect section numbering in cmake/CpulimitOptions.cmake, improving readability and documentation consistency.
Changes:
- Moved the Doxygen comment for
run_pid_or_exe_mode()to sit directly above its definition (instead of being stranded abovereport_process_not_found()). - Renumbered CMake section headers to restore sequential ordering (1–4).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/limiter.c |
Repositions the run_pid_or_exe_mode() Doxygen block to the correct function definition site. |
cmake/CpulimitOptions.cmake |
Fixes section header numbering to be sequential after prior refactor removals. |
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.
Two cosmetic/structural issues introduced by the recent refactoring.
Changes
src/limiter.c— The Doxygen comment forrun_pid_or_exe_mode()was stranded betweenrun_command_mode()and the static helperreport_process_not_found(), leavingrun_pid_or_exe_mode()with no comment at its definition site. Moved it directly above the function it documents.Before:
After:
report_process_not_foundcomment stays,run_pid_or_exe_modecomment moves to sit directly above it.cmake/CpulimitOptions.cmake— Section headers were numbered 1, 3, 4, 5 (section 2 was removed during refactoring without renumbering the rest). Corrected to 1, 2, 3, 4.📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.