diff --git a/CHANGELOG b/CHANGELOG index 21e3aa9..849fe80 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -14,31 +14,31 @@ * Writing files using WAVEFORMATEXTENSIBLE format is not supported - all files will be written as a "vanilla" file regardless of the number of channels or sample format. -* `Reader` and `Writer` can now be constructed using with an open `IO` instance, - to allow reading/writing using an arbitrary `IO`-like object (`File`, - `StringIO`, etc). Previously, they could only be constructed from a file name - (given by a String). Thanks to [@taf2](https://github.com/taf2) for suggesting - this feature and providing an example pull request. -* The buffer size in `Reader.each_buffer()` is now optional. If not given, a +* Reader and Writer can now be constructed using with an open IO instance, + to allow reading/writing using an arbitrary IO-like object (File, StringIO, + etc). Previously, they could only be constructed from a file name (given by + a String). Thanks to [@taf2](https://github.com/taf2) for suggesting this + feature and providing an example pull request. +* The buffer size in Reader.each_buffer() is now optional. If not given, a default buffer size will be used. -* Two `Duration` objects will now evaluate to equal if they represent the same - amount of time, due to an overridden definition of `==`. Thanks to +* Two Duration objects will now evaluate to equal if they represent the same + amount of time, due to an overridden definition of ==. Thanks to [Christopher Smith](https://github.com/chrylis) for suggesting this improvement. -* A `ReaderClosedError` is now raised (instead of `IOError`) when attempting to - read from a closed `Reader` instance. However, `ReaderClosedError` extends - `IOError`. -* A `WriterClosedError` is now raised (instead of `IOError`) when attempting to - read from a closed `Writer` instance. However, `ReaderClosedError` extends - `IOError`. +* A ReaderClosedError is now raised (instead of IOError) when attempting to + read from a closed Reader instance. However, ReaderClosedError extends + IOError. +* A WriterClosedError is now raised (instead of IOError) when attempting to + read from a closed Writer instance. However, ReaderClosedError extends + IOError. * **Backwards Incompatible Changes** - * `Reader.file_name` and `Writer.file_name` have been removed. When a `Reader` - or `Writer` instance is constructed from an `IO` instance, this field + * Reader.file_name and Writer.file_name have been removed. When a Reader + or Writer instance is constructed from an IO instance, this field wouldn't necessarily have a sensible value. Since I don't know of an obvious use-case for these fields, going ahead and removing them altogether. - * The long deprecated ability to provide the sample format for a `Format` + * The long deprecated ability to provide the sample format for a Format instance as an integer (implying PCM format) has been removed. For example, - this is no longer valid: `Format.new(:mono, 16, 44100)`. Instead, use - `Format.new(:mono, :pcm_16, 44100)`. + this is no longer valid: Format.new(:mono, 16, 44100). Instead, use + Format.new(:mono, :pcm_16, 44100). 0.7.0