Skip to content

Improve specs for profiling-relates functions #12563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
whatyouhide merged 1 commit into from
May 16, 2023
Merged

Improve specs for profiling-relates functions #12563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/mix/lib/mix/tasks/profile.cprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ defmodule Mix.Tasks.Profile.Cprof do
* `:module` - filters out any results not pertaining to the given module

"""
@spec profile((-> any()), keyword()) :: any()
@spec profile((-> result), keyword()) :: result when result: any()
def profile(fun, opts \\ []) when is_function(fun, 0) do
Mix.ensure_application!(:tools)
{return_value, num_matched_functions, analysis_result} = profile_and_analyse(fun, opts)
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/lib/mix/tasks/profile.eprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ defmodule Mix.Tasks.Profile.Eprof do
* `:sort` - sort the results by `:time` or `:calls` (default: `:time`)

"""
@spec profile((-> any()), keyword()) :: any()
@spec profile((-> result), keyword()) :: result when result: any()
def profile(fun, opts \\ []) when is_function(fun, 0) do
Mix.ensure_application!(:tools)
{return_value, results} = profile_and_analyse(fun, opts)
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/lib/mix/tasks/profile.fprof.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ defmodule Mix.Tasks.Profile.Fprof do
usage for larger workloads.

"""
@spec profile((-> any()), keyword()) :: any()
@spec profile((-> result), keyword()) :: result when result: any()
def profile(fun, opts \\ []) when is_function(fun, 0) do
Mix.ensure_application!(:runtime_tools)
Mix.ensure_application!(:tools)
Expand Down