defining history config option directly in Config class and documenting it

This commit is contained in:
John Mair 2011-05-30 03:37:12 +12:00
parent 62f0b95812
commit 7bc03759d9
1 changed files with 11 additions and 0 deletions

View File

@ -70,6 +70,17 @@ class Pry
# Determines whether plugins should be loaded.
# @return [Boolean]
attr_accessor :should_load_plugins
# Config option for history.
# sub-options include hist.file, hist.load, and hist.save
# hist.file is the file to save/load history too, e.g
# Pry.config.history.file = "~/.pry_history".
# hist.load is a boolean that determines whether history will be
# loaded from hist.file at session start.
# hist.save is a boolean that determines whether history will be
# saved to hist.file at session end.
# @return [OpenStruct]
attr_accessor :history
end
end