Made changes relating to 5.1.3. See changelog for details.

docs/changelog.rst

@@ -3,6 +3,34 @@ Change Log
 ##########
 This page documents the additions, changes, fixes, deprecations and removals made in each release.
 
+******
+v5.1.3
+******
+**Release Date: 2022-10-27**
+
+Fixed
+=====
+
+Core Object
+-----------
+Fixes in the :doc:`core-object-methods`.
+
+* Fixed the docstring for the :py:meth:`khoros.core.Khoros.Setting.define_node_setting` method
+  to reflect the proper default value of the ``return_json`` parameter and to define the correct
+  return value.
+
+Primary Modules
+---------------
+Fixes in the :doc:`primary modules <primary-modules>`.
+
+* Fixed the docstring for the :py:meth:`khoros.objects.settings.define_node_setting` function
+  to reflect the proper default value of the ``return_json`` parameter and to define the correct
+  return value.
+
+|
+
+-----
+
 ******
 v5.1.2
 ******

khoros/core.py

@@ -3885,14 +3885,14 @@ def define_node_setting(self, setting_name, setting_val, node_id, node_type='boa
             :type node_id: str
             :param node_type: Defines the node as a ``board`` (default), ``category`` or ``grouphub``
             :type node_type: str
-            :param return_json: Returns a simple JSON dictionary indicating the operation result (``False`` by default)
+            :param return_json: Returns a simple JSON dictionary indicating the operation result (``True`` by default)
 
                                 .. caution:: An unsuccessful REST call will result in the raising of the
                                              :py:exc:`khoros.errors.exceptions.PostRequestError` exception if the
                                              ``return_json`` parameter is set to ``False``.
 
             :type return_json: bool
-            :returns: None
+            :returns: The API response as a dictionary
             :raises: :py:exc:`ValueError`, :py:exc:`TypeError`,
                      :py:exc:`khoros.errors.exceptions.APIConnectionError`,
                      :py:exc:`khoros.errors.exceptions.POSTRequestError`,

khoros/objects/settings.py

@@ -174,7 +174,7 @@ def define_node_setting(khoros_object, setting_name, setting_val, node_id, node_
 
     .. versionchanged:: 3.3.2
        The ``return_json`` parameter has been introduced which returns a simple JSON object (as a ``dict``)
-       indicating whether or not the operation was successful. (Currently ``False`` by default)
+       indicating whether the operation was successful. (Currently ``False`` by default)
 
     .. versionchanged:: 3.3.1
        A minor fix was made to the docstring to correct a Sphinx parsing issue. The function itself was not changed.
@@ -191,14 +191,14 @@ def define_node_setting(khoros_object, setting_name, setting_val, node_id, node_
     :type node_id: str
     :param node_type: Defines the node as a ``board`` (default), ``category`` or ``grouphub``
     :type node_type: str
-    :param return_json: Returns a simple JSON dictionary indicating the operation result (``False`` by default)
+    :param return_json: Returns a simple JSON dictionary indicating the operation result (``True`` by default)
 
                         .. caution:: An unsuccessful REST call will result in the raising of the
                                      :py:exc:`khoros.errors.exceptions.PostRequestError` exception if the
                                      ``return_json`` parameter is set to ``False``.
 
     :type return_json: bool
-    :returns: None (or a dictionary if function call includes the ``return_json=True`` kwarg)
+    :returns: The API response as a dictionary
     :raises: :py:exc:`ValueError`, :py:exc:`TypeError`,
              :py:exc:`khoros.errors.exceptions.APIConnectionError`,
              :py:exc:`khoros.errors.exceptions.POSTRequestError`,