From f3649d1ffb34c5a5b435f5795da81ca22d23699e Mon Sep 17 00:00:00 2001 From: Leo Correa Date: Tue, 4 Dec 2012 13:33:12 -0500 Subject: [PATCH 1/3] Improved readme --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04cc726..148bb8f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,18 @@ [![Build Status](https://secure.travis-ci.org/samdunne/rdata.png?branch=master)](https://travis-ci.org/samdunne/rdata) [![Dependency Status](https://gemnasium.com/samdunne/rdata.png)](https://gemnasium.com/samdunne/rdata) +## Purpose + +Project goal is to provide a very clear and concise library of datastructures and algorithms in Ruby. + +## Data Structures + +[Stacks](#stacks) + +[Queues](#queues) + +[Linked Lists](#linked-lists) + ## Installation ```ruby gem install rdata @@ -19,7 +31,7 @@ gem 'rdata' require 'rdata' ``` -## Stacks +##Stacks ### Initialization @@ -37,4 +49,20 @@ require 'rdata' ``` ### More on Stacks -[Stacks - Wiki Link](https://github.com/samdunne/rdata/wiki/Stacks) \ No newline at end of file +[Stacks - Wiki Link](https://github.com/samdunne/rdata/wiki/Stacks) + +##Queues + +### Initialization + +```ruby +@queue = RData::Queue.new +``` + +### Operations + +```ruby +@queue.enqueue(x) # => Returns 'x' +@queue.dequeue # => Returns 'head' +``` + From 6870a058bab363568502a49720aacd9b0b9618f9 Mon Sep 17 00:00:00 2001 From: Leo Correa Date: Tue, 4 Dec 2012 13:38:54 -0500 Subject: [PATCH 2/3] Removed unimplemented things from docs --- README.md | 21 +-------------------- 1 file changed, 1 insertion(+), 20 deletions(-) diff --git a/README.md b/README.md index 148bb8f..686ebb7 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,7 @@ Project goal is to provide a very clear and concise library of datastructures an ## Data Structures -[Stacks](#stacks) - -[Queues](#queues) - -[Linked Lists](#linked-lists) +* [Stacks](#stacks) ## Installation ```ruby @@ -51,18 +47,3 @@ require 'rdata' ### More on Stacks [Stacks - Wiki Link](https://github.com/samdunne/rdata/wiki/Stacks) -##Queues - -### Initialization - -```ruby -@queue = RData::Queue.new -``` - -### Operations - -```ruby -@queue.enqueue(x) # => Returns 'x' -@queue.dequeue # => Returns 'head' -``` - From ece1dbecd1e2db9da04dfcc4483846919f414ded Mon Sep 17 00:00:00 2001 From: Leo Correa Date: Tue, 4 Dec 2012 13:39:36 -0500 Subject: [PATCH 3/3] Namespaced specs for future tests --- spec/rdata_spec.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/spec/rdata_spec.rb b/spec/rdata_spec.rb index ce60b8c..1cf85fd 100644 --- a/spec/rdata_spec.rb +++ b/spec/rdata_spec.rb @@ -1,6 +1,6 @@ require 'spec_helper' -describe RData do +describe RData::Stack do let(:stack) { RData.Stack } @@ -44,3 +44,5 @@ end end + +