395897779086894349c735f94625727adb4e9cfd — Tim Morgan 1 year, 4 months ago d91fede
Tweak docs
2 files changed, 4 insertions(+), 8 deletions(-)

M README.md
M src/lib.rs
M README.md => README.md +1 -3
@@ 1,8 1,6 @@ # ruby-wrap-data
  
- ## Ruby Wrap Data
- 
- `ruby_wrap_data` is a crate that provides a fairly low-level means of doing
+ `ruby_wrap_data` is a module that provides a fairly low-level means of doing
  what Ruby's `Data_Wrap_Struct` macro does. That is to say, you can store a
  pointer to a Rust `Box<T>` inside a Ruby object and get it back out again.
  

M src/lib.rs => src/lib.rs +3 -5
@@ 1,6 1,4 @@-//! # Ruby Wrap Data
- //!
- //! `ruby_wrap_data` is a crate that provides a fairly low-level means of doing
+ //! `ruby_wrap_data` is a module that provides a fairly low-level means of doing
  //! what Ruby's `Data_Wrap_Struct` macro does. That is to say, you can store a
  //! pointer to a Rust `Box<T>` inside a Ruby object and get it back out again.
  //!


@@ 120,7 118,7 @@ /// # Arguments
  ///
  /// * `klass` - a Ruby Class
- /// * `data`  - an Option<Box<T>> - the data you wish to embed in the Ruby object or None
+ /// * `data`  - an `Option<Box<T>>` - the data you wish to embed in the Ruby object or None
  pub fn wrap<T>(klass: Value, data: Option<Box<T>>) -> Value {
      let datap = if data.is_some() {
          Box::into_raw(data.unwrap()) as *mut c_void


@@ 170,7 168,7 @@ /// # Arguments
  ///
  /// * `object` - a Ruby object
- /// * `data`   - a Box<T> - the data you wish to embed in the Ruby object
+ /// * `data`   - a `Box<T>` - the data you wish to embed in the Ruby object
  pub fn set<T>(object: Value, data: Box<T>) {
      let rdata = rdata(object);
      let datap = Box::into_raw(data) as *mut c_void;