search

brendon / acts_as_list

An ActiveRecord plugin for managing lists.
http://brendon.github.io/acts_as_list/
MIT License
2.05k stars 356 forks source link

Adds description about various options available with the acts_as_list method #168

Closed udit7590 closed 9 years ago

swanandp commented 9 years ago

This documentation is best left to the code. By putting it in README, we're only repeating ourselves.

udit7590 commented 9 years ago

I think README file is to help developers understand how to use the gem. I faced an issue where I was not able to determine what is the default value that is being picked up by position cloumn when I was saving my records. When I finally looked at the code, I realized that I can actually use the option add_new_at available with the acts_as_list method. If it would have been present in README file it would have saved a lot of time for me. Hence I believe README file should tell about all the behavior and options available with the gem to help developers understand how wisely they could use the gem.

brendon commented 9 years ago

I kind of agree with @udit7590, it is handy to have the options documented in the README. Up to you though Swanand. :)

akshay-vishnoi commented 9 years ago

:+1:

swanandp commented 9 years ago

Alright, let's put it in. @udit7590 Can you make the fix I commented on, and then squash the two commits? I am generally not in favour of squashing, but the commits here are tiny enough to warrant a squash.

udit7590 commented 9 years ago

@swanandp Squashed and fixed the changes.

swanandp commented 9 years ago

Alright, merging this in.