From c50106e191049a582a4d400f637e29b7b67fea48 Mon Sep 17 00:00:00 2001 From: Per Lundberg Date: Thu, 1 Jun 2017 17:06:05 +0300 Subject: [PATCH] README: Added note about json/add/exception --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 45e1348b..2ef93dcb 100644 --- a/README.md +++ b/README.md @@ -150,6 +150,18 @@ require 'json/add/rails' Both of the additions attempt to require `'json'` (like above) first, if it has not been required yet. +## Serializing exceptions + +The JSON module doesn't extend `Exception` by default. If you convert an `Exception` +object to JSON, it will by default only include the exception message. + +To include the full details, you must either load the load the `json/add/core` mentioned +above, or specifically load the exception addition: + +```ruby +require 'json/add/exception' +``` + ## More Examples To create a JSON document from a ruby data structure, you can call