Giters

ruby-prof / ruby-prof

A ruby profiler. See https://ruby-prof.github.io for more information.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Misleading warning

akimd opened this issue · comments

commented

Hi,

I have lost quite some time because of these messages:

NOTE: RubyProf.profile is deprecated; use Profile.profile instead. It will be removed on or after 2023-06.

So I believed that RubyProf was replaced by some other Profile gem. It took quite some time to understand that the message should actually read

NOTE: RubyProf.profile is deprecated; use RubyProf::Profile.profile instead. It will be removed on or after 2023-06.

That may save other people's time.

Cheers.

commented

Sure, that works.

commented

So if calling RubyProf.start etc. is deprecated, does that mean the documentation at https://ruby-prof.github.io is outdated? Because the "convenience API" section there all uses RubyProf directly...

commented

Yes, the docs need to be updated.