1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

[ruby/pstore] Enhanced RDoc

https://github.com/ruby/pstore/commit/c12560e59a
This commit is contained in:
BurdetteLamar 2022-06-30 14:00:06 -05:00 committed by git
parent ce5aa6d4af
commit 6f26a6cdef

View file

@ -38,7 +38,14 @@ require "digest"
# == About the Examples
#
# Examples on this page need a store that has known properties.
# Therefore examples may assume the existence of this helper method:
# They can get a new (and populated) store by calling thus:
#
# example_store do |store|
# # Example code using store goes here.
# end
#
# The implementation of +example_store+
# (which is profoundly unimportant here):
#
# require 'pstore'
# require 'tempfile'
@ -56,12 +63,6 @@ require "digest"
# yield store
# end
#
# This means that example code can look like this:
#
# example_store do |store|
# # Example code using store goes here.
# end
#
# == The Store
#
# The contents of the store are maintained in a file whose path is specified