Skip to content

Commit ec44427

Browse files
committed
Update api-docs.txt
1 parent a8e3ce5 commit ec44427

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

pointblank/data/api-docs.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5490,9 +5490,12 @@ get_step_report(self, i: 'int', columns_subset: 'str | list[str] | Column | None
54905490
column selector expressions don't resolve to any columns.
54915491
header
54925492
Options for customizing the header of the step report. The default is the `":default:"`
5493-
value which produces a generic header. Aside from this default, text can be provided for
5494-
the header. This will be interpreted as Markdown text and transformed internally to
5495-
HTML.
5493+
value which produces a header with a standard title and set of details underneath. Aside
5494+
from this default, free text can be provided for the header. This will be interpreted as
5495+
Markdown text and transformed internally to HTML. You can provide one of two templating
5496+
elements: `{title}` and `{details}`. The default header has the template
5497+
`"{title}{details}"` so you can easily start from that and modify as you see fit. If you
5498+
don't want a header at all, you can set `header=None` to remove it entirely.
54965499
limit
54975500
The number of rows to display for those validation steps that check values in rows (the
54985501
`col_vals_*()` validation steps). The default is `10` rows and the limit can be removed

0 commit comments

Comments
 (0)