Compatibility API: README is misleading #86

Open
dtsadok opened this Issue Oct 19, 2011 · 2 comments

Comments

Projects
None yet
3 participants
@dtsadok

dtsadok commented Oct 19, 2011

On the main README, the compatibility API is listed as the third feature, and there's a whole section on how wonderful it is (which it is): "That's right, you can just replace "require 'json'" with the line above and you're done!"

But when you actually use it, you get an ugly deprecation error. If the feature is being deprecated and removed, the README should reflect that, and not advertise the feature...

@brianmario

This comment has been minimized.

Show comment
Hide comment
@brianmario

brianmario Oct 19, 2011

Owner

Good call, I missed that in the master branch. It's already been updated in the 2.0 branch, I'll try and fix it when I get home later.

Owner

brianmario commented Oct 19, 2011

Good call, I missed that in the master branch. It's already been updated in the 2.0 branch, I'll try and fix it when I get home later.

@padde

This comment has been minimized.

Show comment
Hide comment
@padde

padde Jun 19, 2014

So, as you are probably deprecating the JSON compatibility API, how about fixes for it? I noticed the typo compatability instead of compatibility in several places. Problem is that it appears in a method name, so the old method should be printing a warning. If you would like I could make a PR, just let me know.

padde commented Jun 19, 2014

So, as you are probably deprecating the JSON compatibility API, how about fixes for it? I noticed the typo compatability instead of compatibility in several places. Problem is that it appears in a method name, so the old method should be printing a warning. If you would like I could make a PR, just let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment