expanded documentation for using Oj to replace JSON #714
Conversation
|
@ohler55 I threw this together. give me any and all feedback, i won't be offended if you don't like my copy. I took the bold move of making a prominent new section in the Readme. Im thinking this is useful, when I was trying to figure this out I was surprised to not find a quick guide in the docs or blog posts. let me know what you think! question: is Oj::Rails.mimic_JSON different from Oj.mimic_JSON? irb(main):012:0> Oj::Rails.method(:mimic_JSON) == Oj.method(:mimic_JSON) |
README.md
Outdated
| @@ -32,6 +32,15 @@ puts "Same? #{h == h2}" | |||
| # true | |||
| ``` | |||
|
|
|||
| ## Universally and seamlessly replacing slow JSON methods with faster Oj equivalents | |||
There was a problem hiding this comment.
Oj is used often with Rails but this section places Oj use in rails before even the installation. A better place would be in the Rails.md file or maybe somewhere in the Further Reading section area.
|
I think you have highlighted the need for a useful addition to the readme. There are a few different ways to categorize Oj features but I think most would break down the use as either rails, json gem replacement, or native Oj use. Native Oj use could be broken down further but if a section on the different uses is added it should cover all three albeit only briefly along the lines of what you started with. |
jjb
force-pushed
the
doc-additions
branch
4 times, most recently
from
66d1ca8
to
f42c06d
Compare
|
thanks for the feedback! i refined my approach and the copy, see the new small sections below Installation. (i had previously put my additions before installation because that's where the existing Using section is) rational for keeping something in the main PR is i'm guessing the portion of people coming to the readme to find this specific information is very large. let me know if you still want changes! when it looks good i'll squish the commits |
|
Looks good. |
|
Cool! |
No description provided.