You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While trying to make small docs update PR I found out the next facts that probably should be addressed:
The repo has no indication that it is the default Ruby's JSON implementation, it just states that "it is an implementation" (therefore I falsely believed that upstream for stdlib json is ruby/ruby repo, and this one is just a pre-Ruby 2 standalonge gem);
The json gem and json stdlib share some, but not all, code and docs, which lead to the weird effects:
the whole thing about two implementation (C and pure) has an effect on design and docs, but "pure" implementation is not imported into Ruby trunk, which, for example, renders documentation pieces like this:
(JSON::Pure::Generator is not a thing in stdlib);
moreover, considering no need for two implementations, the library code and interface can be simplified significantly (no .generator and .parser attributes, no need to have a separate Common module and so on);
most of the detailed docs on gem usage and examples are in README, but not in JSON module's RDoc, and are not accessible from the standard library docs
Is it possible to somehow "freezing" the fact that json gem for future Ruby versions should only be available through stdlib, and simplify the library accordingly?
The text was updated successfully, but these errors were encountered:
Yeah, the thing with confusing standard docs due to two generators is still relevant:
...but since 2018 I came to understanding that it is not that simple.
I’ll try to look into improving the approach to the documentation in upcoming months, as the gem now is in active maintenance!
While trying to make small docs update PR I found out the next facts that probably should be addressed:
json
isruby/ruby
repo, and this one is just a pre-Ruby 2 standalonge gem);json
gem andjson
stdlib share some, but not all, code and docs, which lead to the weird effects:(
JSON::Pure::Generator
is not a thing in stdlib);.generator
and.parser
attributes, no need to have a separateCommon
module and so on);JSON
module's RDoc, and are not accessible from the standard library docsIs it possible to somehow "freezing" the fact that
json
gem for future Ruby versions should only be available through stdlib, and simplify the library accordingly?The text was updated successfully, but these errors were encountered: