From f8e927ca6c66a62b262677e4f822f3d3ada1cde4 Mon Sep 17 00:00:00 2001 From: Samar Hassan <88422175+samar-hassan@users.noreply.github.com> Date: Wed, 10 Jan 2024 14:32:04 +0000 Subject: [PATCH 1/3] update incorrect spelling in docs --- docs/intro/loading-and-saving-data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/loading-and-saving-data.rst b/docs/intro/loading-and-saving-data.rst index 952bb86..1d99ac9 100644 --- a/docs/intro/loading-and-saving-data.rst +++ b/docs/intro/loading-and-saving-data.rst @@ -2,7 +2,7 @@ Loading and saving data ####################### -Saving and loaded of resources is handled by codecs for each format. +Saving and loading of resources is handled by codecs for each format. JSON data ========= From b9dd65212e41757969d24635bcf1e791c3e11fc5 Mon Sep 17 00:00:00 2001 From: Samar Hassan Date: Wed, 10 Jan 2024 14:43:01 +0000 Subject: [PATCH 2/3] add apostrophe --- docs/intro/loading-and-saving-data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/loading-and-saving-data.rst b/docs/intro/loading-and-saving-data.rst index 1d99ac9..514e33a 100644 --- a/docs/intro/loading-and-saving-data.rst +++ b/docs/intro/loading-and-saving-data.rst @@ -8,7 +8,7 @@ JSON data ========= JSON data is loaded and saved using the :py:mod:`odin.codecs.json_codec` module. This module exposes an API that is very -similar to Pythons built in :py:mod:`json` module. +similar to Python's built in :py:mod:`json` module. Using the Book and Author resources presented in the :doc:`creating-resources` section:: From ef81f632fffa4d4b8befb910246f837a85f5af7a Mon Sep 17 00:00:00 2001 From: Samar Hassan Date: Wed, 10 Jan 2024 14:56:08 +0000 Subject: [PATCH 3/3] fix docstring --- src/odin/codecs/json_codec.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/odin/codecs/json_codec.py b/src/odin/codecs/json_codec.py index 4816c99..471d643 100644 --- a/src/odin/codecs/json_codec.py +++ b/src/odin/codecs/json_codec.py @@ -52,7 +52,7 @@ def default(self, o): def load(fp, resource=None, full_clean=True, default_to_not_supplied=False): """ - Load a from a JSON encoded file. + Load from a JSON encoded file. See :py:meth:`loads` for more details of the loading operation.