Refactor and docs: fix typo, reformat code, update README#1009
Refactor and docs: fix typo, reformat code, update README#1009opcm merged 5 commits intointel:masterfrom
Conversation
v1k1nghawk
commented
Apr 1, 2026
- Fix typo in print_output()
- Convert indentation from tabs to spaces for consistency (according to project's Coding Style)
- Update README.md to include more user-friendly robust instructions for build directory creation, otherwise, if a user would like to repeat the step they will get an error: "mkdir: cannot create directory ‘build’: File exists" because the directory persists from a previous attempt
|
Regarding the rest of the changes, I've discussed this with @rdementi in the past but it is probably better to change indentation only there where you make actual changes. |
1cf43ec to
735d63d
Compare
- Fix typo in print_output() - Convert indentation from tabs to spaces for consistency (according to project's Coding Style) - Update README.md to include more robust instruction for build directory creation
735d63d to
09ed30d
Compare
Thank you for the clarification, I've reverted the indentation changes from the PR. |
There was a problem hiding this comment.
Pull request overview
This PR cleans up user-facing documentation and messaging by correcting a metric description typo in the PCM output and improving the README build instructions to avoid common “build directory already exists” errors.
Changes:
- Fixes a typo in the
UTILmetric description printed byprint_output(). - Updates README build steps to include options for reusing vs. recreating the
build/directory.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/pcm.cpp |
Corrects a typo in the printed UTIL description string. |
README.md |
Adds build-directory setup guidance (incremental vs. clean build) before the compile steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Quick Update rephrasing Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>