Skip to content

Commit f1c41c2

Browse files
authored
Merge pull request #1400 from pgf-tikz/docs/default-and-initial
docs: format "default XXX, initially XXX" correctly
2 parents 0407fee + da9589b commit f1c41c2

File tree

6 files changed

+704
-3
lines changed

6 files changed

+704
-3
lines changed

build.lua

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ specialformats["latex"] = specialformats["latex"] or
3535
checkengines = {"pdftex", "latexdvips", "latexdvisvgm", "luatex", "xetex"}
3636

3737
-- Use multiple sets of tests
38-
checkconfigs = { "build", "config-gd" }
38+
checkconfigs = { "build", "config-gd", "config-manual" }
3939

4040
-- For release
4141
ctanzip = "pgf.ctan.flatdir"
@@ -79,4 +79,3 @@ function tag_hook(tagname, tagdate)
7979
file:close()
8080
return 0
8181
end
82-

config-manual.lua

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
-- Tests for pgfmanual macros
2+
3+
stdengine = "luatex"
4+
checkengines = {"luatex"}
5+
testfiledir = "testfiles-manual"
6+
7+
-- this copies all doc sources "pgfmanual-en-xxx.tex", which are unneeded
8+
testsuppdir = "./doc/generic/pgf"

doc/generic/pgf/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
66

7+
## Unreleased
8+
9+
### Fixed
10+
11+
- Fix formatting of `default XXX, initially XXX` in key docs #1278
12+
713
## [3.1.11] - 2025-08-14 Henri Menke
814

915
### BREAKING CHANGES

testfiles-manual/key-env.lvt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
% based on pgfmanual-test.tex
2+
\input{regression-test}
3+
\documentclass[a4paper,doc2]{ltxdoc}
4+
5+
\input{pgfmanual.cfg} % default engine is LuaTeX
6+
\input{pgfmanual-en-main-preamble.tex}
7+
8+
\showoutput
9+
10+
\begin{document}
11+
12+
\START
13+
14+
\begin{key}{/path/x=value}
15+
\end{key}
16+
17+
\begin{key}{/path/x=value (default XXX)}
18+
\end{key}
19+
20+
\begin{key}{/path/x=value (initially XXX)}
21+
\end{key}
22+
23+
% see #1278
24+
\begin{key}{/path/x=value (default XXX, initially XXX)}
25+
\end{key}
26+
27+
% values containing "=", see #1325
28+
\begin{key}{/path/x=value (default {K=V})}
29+
\end{key}
30+
31+
\begin{key}{/path/x=value (initially {K=V})}
32+
\end{key}
33+
34+
\begin{key}{/path/x=value (default {K=V}, initially {K=V})}
35+
\end{key}
36+
37+
\end{document}

0 commit comments

Comments
 (0)