Skip to content
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

Jump to bottom

Deprecate SuperSpreader::StopSignal and related methods #69

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Deprecate SuperSpreader::StopSignal and related methods #69

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
6 changes: 6 additions & 0 deletions lib/super_spreader/stop_signal.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,21 @@
require "redis"

module SuperSpreader
# @deprecated Please use TrackBallast::StopSignal instead
module StopSignal
# @deprecated Please use {TrackBallast::StopSignal.stop!} instead
def stop!
warn "DEPRECATION WARNING: the class SuperSpreader::StopSignal is deprecated and will be removed in v1.0. " \
"Use TrackBallast::StopSignal instead."
Comment on lines +10 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also the built-in deprecate method, which may provide some advantages. I'm unsure, to be honest. Do you have an opinion on this option? (I could go either way.)

redis.set(stop_key, true)
end

# @deprecated Please use {TrackBallast::StopSignal.go!} instead
def go!
redis.del(stop_key)
end

# @deprecated Please use {TrackBallast::StopSignal.stopped?} instead
Comment on lines +8 to +20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When previewing the documentation using rake doc, these warnings appear:

[warn]: In file `lib/super_spreader/stop_signal.rb':7: Cannot resolve link to TrackBallast::StopSignal.go! from text:
	...{TrackBallast::StopSignal.go!}...
[warn]: In file `lib/super_spreader/stop_signal.rb':7: Cannot resolve link to TrackBallast::StopSignal.stop! from text:
	...{TrackBallast::StopSignal.stop!}...
[warn]: In file `lib/super_spreader/stop_signal.rb':7: Cannot resolve link to TrackBallast::StopSignal.stopped? from text:
	...{TrackBallast::StopSignal.stopped?}...
[warn]: In file `lib/super_spreader/stop_signal.rb':16: Cannot resolve link to TrackBallast::StopSignal.go! from text:
	...{TrackBallast::StopSignal.go!}...
[warn]: In file `lib/super_spreader/stop_signal.rb':9: Cannot resolve link to TrackBallast::StopSignal.stop! from text:
	...{TrackBallast::StopSignal.stop!}...
[warn]: In file `lib/super_spreader/stop_signal.rb':21: Cannot resolve link to TrackBallast::StopSignal.stopped? from text:
	...{TrackBallast::StopSignal.stopped?}...

It makes sense that it can't resolve the links because we are moving StopSignal to a different gem in doximity/track_ballast#19. When the curly braces are removed, the warnings go away and the resulting documentation appears to be identical. What do you think about this change?

Suggested change
# @deprecated Please use {TrackBallast::StopSignal.stop!} instead
def stop!
warn "DEPRECATION WARNING: the class SuperSpreader::StopSignal is deprecated and will be removed in v1.0. " \
"Use TrackBallast::StopSignal instead."
redis.set(stop_key, true)
end
# @deprecated Please use {TrackBallast::StopSignal.go!} instead
def go!
redis.del(stop_key)
end
# @deprecated Please use {TrackBallast::StopSignal.stopped?} instead
# @deprecated Please use TrackBallast::StopSignal.stop! instead
def stop!
warn "DEPRECATION WARNING: the class SuperSpreader::StopSignal is deprecated and will be removed in v1.0. " \
"Use TrackBallast::StopSignal instead."
redis.set(stop_key, true)
end
# @deprecated Please use TrackBallast::StopSignal.go! instead
def go!
redis.del(stop_key)
end
# @deprecated Please use TrackBallast::StopSignal.stopped? instead

Screenshot 2024-02-13 at 13 15 23

def stopped?
redis.exists(stop_key).positive?
end
Expand Down