Re: [PATCH] PStore Documentation

Daniel Berger wrote:
> James Edward Gray II wrote:
> 
>> The attached patch completely documents the PStore library.  Please  
>> let me know if there are any issues with it.  Otherwise, would some  
>> kind soul please apply this?
>>
>> James Edward Gray II
>>
> 
> Very nice James.  Good work.
> 
> - Dan
> 
> 

Me again.

A couple corrections & suggestions:

"An object hierarchy may be just a single object, of course."
- Remove 'of course'.

"Then later user code may read values back from the data store or even update
data, as needed."
- 'User code may later read values back from the data store or even update 
data, as needed'

"Behind the seens, Ruby objects are stored to the data store file with Marhsal."
- s/seens/scenes
- s/Marhsal/Marshal

"wiki[:wiki_index]         ||= Array.new"
- Remove the extra whitespace

"To construct a PStore object, simply pass in the _file_ path where you would"
- Remove 'simply'

"store.abort         # end transaction here, dicard all changes"
- s/dicard/discard

As a general suggestion, remove the unnecessary parens when referring to methods:

"# This method is just a wrapped around Marshal.load()."
- This method is just a wrapped around Marshal.load.

Also, I think we ought to get rid of the "if $0 == __FILE__" code.  Or do 
people really use that?

Regards,

Dan

PS - What's the proper way to diff a diff?