Skip to content

Fix a few inconsistencies in the README #1045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
byroot merged 1 commit into from
Jun 27, 2026
+5 −5
Merged

Fix a few inconsistencies in the README #1045

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Both of these behavior can be disabled using the `strict: true` option:

```ruby
JSON.generate(Object.new, strict: true) # => Object not allowed in JSON (JSON::GeneratorError)
JSON.generate(Position.new(1, 2)) # => Position not allowed in JSON (JSON::GeneratorError)
JSON.generate(Position.new(1, 2), strict: true) # => Position not allowed in JSON (JSON::GeneratorError)
```

## JSON::Coder
Expand Down Expand Up @@ -117,13 +117,13 @@ It is also called for objects that do have a JSON equivalent, but are used as Ha
as well as for strings that aren't valid UTF-8:

```ruby
coder = JSON::Combining.new do |object, is_object_key|
coder = JSON::Coder.new do |object, is_object_key|
case object
when String
if !string.valid_encoding? || string.encoding != Encoding::UTF_8
Base64.encode64(string)
if !object.valid_encoding? || object.encoding != Encoding::UTF_8
Base64.encode64(object)
else
string
object
end
else
object
Expand Down