Add comments on the run_as_executable variable

This commit is contained in:
kojix2 2021-07-12 14:49:23 +09:00
parent dbbfd366be
commit f67a5ce913

View File

@ -6,6 +6,12 @@ require_relative 'youplot/parameters'
require_relative 'youplot/command' require_relative 'youplot/command'
module YouPlot module YouPlot
# @run_as_executable = true / false
# YouPlot behaves slightly differently when run as a command line tool
# and when run as a script (e.g. for testing). In the event of an error,
# when run as a command line tool, YouPlot will display a short error message
# and exit abnormally. When run as a script, it will just raise an error.
@run_as_executable = false
class << self class << self
attr_accessor :run_as_executable attr_accessor :run_as_executable
@ -13,5 +19,4 @@ module YouPlot
@run_as_executable @run_as_executable
end end
end end
@run_as_executable = false
end end