Fix unclosed code block in docs/README.md#9669
Fix unclosed code block in docs/README.md#9669maliberty merged 1 commit intoThe-OpenROAD-Project:masterfrom
Conversation
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly fixes an unclosed code block in docs/README.md and adds formatting for another code block containing build instructions. However, the newly formatted code block includes a comment that seems to incorrectly describe the function of the make clean command, which could be misleading to users. My review includes a comment to address this potential confusion.
Note: Security Review has been skipped due to the limited scope of the PR.
| The `-j16` command is optional for speeding up the manpage compilation process by using multiple jobs | ||
| based on the number of cores in your system. | ||
|
|
||
| ``` shell |
There was a problem hiding this comment.
By adding ``` shell here, the comment on line 40 (# Note this step is important as it regenerates the documentation using latest sources.) is included in the code block. This comment appears to be incorrect, as the make clean command on line 38 removes generated files, it does not regenerate them (as confirmed by the Makefile). This could be misleading for users. Please consider correcting or removing this comment to accurately reflect the purpose of the make clean command.
There was a problem hiding this comment.
The comment refers to the line following which does regenerate the docs, not the clean line above.
|
clang-tidy review says "All clean, LGTM! 👍" |
|
@maliberty @vvbandeira stuck on DCO in CI? 
|
2 participants
No description provided.