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 reading the JSON module documentation on https://www.rubydoc.info/gems/json/2.5.1/JSON, I noticed that the Overview section was incorrect. The section includes only the frozen_string_literal: false magic comment.
#frozen_string_literal: falserequire'json/common'### = JavaScript \Object Notation (\JSON)## \JSON is a lightweight data-interchange format.
...
Steps to reproduce
This is the minimal reproduction for the issue. I've done my best to remove
all extraneous code and unique environment state on my machine before providing
these steps:
Run git clone https://github.com/flori/json.git
Run cd json
Run git checkout v2.5.1
Run yard
Run open doc/JSON.html
Actual Output
Expected Output
NOTE: The screenshot above can be obtained when I removed all the frozen_string_literal comments.
(via sed -i '' -e '/frozen_string_literal/d' $(git ls-files lib))
Environment details:
OS: macOS Catalina version 10.15.7
Ruby version (ruby -v): ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
While reading the
JSON
module documentation on https://www.rubydoc.info/gems/json/2.5.1/JSON, I noticed that the Overview section was incorrect. The section includes only thefrozen_string_literal: false
magic comment.Here is the source code of
lib/json.rb
:https://github.com/flori/json/blob/v2.5.1/lib/json.rb
Steps to reproduce
This is the minimal reproduction for the issue. I've done my best to remove
all extraneous code and unique environment state on my machine before providing
these steps:
git clone https://github.com/flori/json.git
cd json
git checkout v2.5.1
yard
open doc/JSON.html
Actual Output
Expected Output
NOTE: The screenshot above can be obtained when I removed all the
frozen_string_literal
comments.(via
sed -i '' -e '/frozen_string_literal/d' $(git ls-files lib)
)Environment details:
ruby -v
): ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]yard -v
): yard 0.9.25I have read the Contributing Guide.
The text was updated successfully, but these errors were encountered: