Skip to content

Commit 04c84ba

Browse files
authored
Update api.md
1 parent 4aed96b commit 04c84ba

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ All results stay in memory unless application (all threads including th
2727

2828
#### `get_func_stats(filter=None)`
2929

30-
Returns the function stats as a `YFuncStat` object.
31-
filter parameter can be either following: name, module, lineno, ncall, nactualcall, builtin, ttot, tsub, index, children, ctx_id, tavg, full_name. You can use multiple filters at once in a single call and only those results are returned.
30+
Returns the function stats as a [`YFuncStat`](#yfuncstat) object.
31+
filter parameter can be used to filter on YFuncStat attributes. You can use multiple filters at once in a single call and only those results are returned.
3232

3333
One of the interesting features of this filter function is that you can get per-thread function call statistics only by providing the ctx_id of the thread you want to get results. Under the hood, yappi already holds the function stats by per-thread and upon request, it aggregates this data, when you provide a filter, it simply returns only that per-thread stats.
3434

0 commit comments

Comments
 (0)