Skip to content

Commit 1a04c08

Browse files
committed
update README.md
1 parent 3e2a7c2 commit 1a04c08

1 file changed

Lines changed: 4 additions & 15 deletions

File tree

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ pseudocode2_math_engine = "mathjax3"
3939
# Covers all pseudocode.js native options (unified project-wide style)
4040
pseudocode2_options = {
4141
"lineNumber": True, # Global default: enable line numbering
42-
"lineNumberPunc": " | ", # Punctuation after line numbers (e.g., "1 | ")
43-
"commentDelimiter": "//", # Global default comment delimiter
42+
"lineNumberPunc": " | ", # Punctuation after line numbers (e.g., "1 | ")
43+
"commentDelimiter": "#", # Global default comment delimiter
4444
"noEnd": False, # Global default: show "END" for control blocks
4545
"titlePrefix": "PseudoCode", # Global default title prefix (replace "Algorithm")
46-
"captionCount": True # Global default: enable auto-increment numbering
46+
"scopeLines": True, # Global default: enable scope line highlighting
4747
}
4848
```
4949

@@ -84,18 +84,7 @@ Pseudocode rendering is extended with practical options (all compatible with pse
8484

8585
### Global Configuration via ``pseudocode2_options``
8686

87-
Pseudocode rendering styles can be unified across the entire project using a single global configuration (supports all pseudocode.js native parameters, see [pseudocode.js](https://github.com/SaswatPadhi/pseudocode.js)). The following example shows how to set global options in `conf.py`:
88-
89-
```python
90-
pseudocode2_options = {
91-
"lineNumber": True, # Global default: enable line numbering
92-
"lineNumberPunc": " | ", # Punctuation after line numbers (e.g., "1 | ")
93-
"commentDelimiter": "#", # Global default comment delimiter
94-
"noEnd": False, # Global default: show "END" for control blocks
95-
"titlePrefix": "PseudoCode", # Global default title prefix (replace "Algorithm")
96-
"scopeLines": True, # Global default: enable scope line highlighting
97-
}
98-
```
87+
Pseudocode rendering styles can be unified across the entire project using a single global configuration (supports all pseudocode.js native parameters, see [pseudocode.js](https://github.com/SaswatPadhi/pseudocode.js)). See also the example in the [Quick Start section](#quick-start).
9988

10089
**Priority Rule**:
10190
Configuration priority (higher priority overrides lower): Directive option (e.g., :linenos: in .rst) > pseudocode2_options (global in conf.py) > pseudocode.js default

0 commit comments

Comments
 (0)