Skip to content

Fix unclosed code block in docs/README.md #9669

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.

Sign up for GitHub

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

Merged
maliberty merged 1 commit into from
Mar 6, 2026
+2 −0
Merged

Fix unclosed code block in docs/README.md #9669

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ To install Python packages:
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

### Build instructions for Pandoc manpages

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
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 6, 2026

Choose a reason for hiding this comment

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

medium

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.

Copy link
Member

@maliberty maliberty Mar 6, 2026

Choose a reason for hiding this comment

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

The comment refers to the line following which does regenerate the docs, not the clean line above.

make clean

# Note this step is important as it regenerates the documentation using latest sources.
Expand Down
Loading