Skip to content

Commit f3b5656

Browse files
authored
docs: tweak release notes section header format (#2310)
Better visual differentiation between section and subsection headers. Also apply ruff where lacking in previous commit
1 parent 44ccfb7 commit f3b5656

File tree

4 files changed

+7
-12
lines changed

4 files changed

+7
-12
lines changed

doc/ReleaseNotes/ReleaseNotes.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ \section{Introduction}
152152

153153
% -------------------------------------------------
154154
\section{Release History}
155-
A list of all MODFLOW 6 releases is shown in table \ref{tab:releases}. Changes introduced in previous releases are described in Appendix~\ref{app:A}.
155+
A list of all previous MODFLOW 6 releases is shown in table \ref{tab:releases}. Changes introduced in previous releases are described in Appendix~\ref{app:A}.
156156

157157
\begin{table}[h]
158158
\begin{center}

doc/ReleaseNotes/develop.tex.jinja

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
\subsection{Version mf(( version ))---(( date ))}
2-
31
([ for section_key, section_items in items|groupby("section") ])
4-
\textbf{\underline{(( sections[section_key] ))}}
5-
2+
\subsection{(( sections[section_key].title() ))}
63
([ for subsection_key, subsection_items in section_items|groupby("subsection") ])
74
([ set subsection = subsections[subsection_key] ])
85
([ if subsection|length > 0 ])
9-
\underline{(( subsection ))}
6+
\subsubsection{(( subsection.title() ))}
107
([ endif ])
118

129
\begin{itemize}
1310
([ for item in subsection_items ])
1411
\item (( item.description ))
1512
([ endfor ])
1613
\end{itemize}
17-
1814
([ endfor ])
1915
([ endfor ])

doc/ReleaseNotes/mk_releasenotes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
trim_blocks=True,
3434
lstrip_blocks=True,
3535
line_statement_prefix="_",
36-
keep_trailing_newline=True,
36+
keep_trailing_newline=False,
3737
# since latex uses curly brackets,
3838
# replace block/var start/end tags
3939
block_start_string="([",

doc/mf6io/mf6ivar/deprecations.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,9 @@ def create_deprecations_file(dfndir, mddir, verbose):
4848
s += "| Model-Package | Option | Deprecated | Removed |\n"
4949
s += "|:--------------|:-------|:-----------|:--------|\n"
5050
for file, option, deprecated, removed in deprecations:
51-
s += (
52-
f"| {file.stem} | {option} | {deprecated if deprecated else removed if removed else ''} "
53-
f"| {removed if removed else ''} |\n"
54-
)
51+
deprecated = deprecated if deprecated else removed if removed else ""
52+
removed = removed if removed else ""
53+
s += f"| {file.stem} | {option} | {deprecated} | {removed} |\n"
5554
if len(s) > 0:
5655
s += "\n"
5756
f.write(s)

0 commit comments

Comments
 (0)