Skip to content

Commit ea7c377

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

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ All results stay in memory unless application (all threads including th
2828
#### `get_func_stats(filter=None)`
2929

3030
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.
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. If no filter is defined, all function stats are aggregated(function stats are held per-thread under the hood) and 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)