From 3d8406b6b0e9fd6293b7b2ae80ab629436649a52 Mon Sep 17 00:00:00 2001 From: Zeb Burke-Conte Date: Tue, 23 May 2023 09:29:18 -0700 Subject: [PATCH] Document requesting no noise with a sentinel value --- docs/source/api_reference/noising/index.rst | 2 +- docs/source/configuration/index.rst | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/api_reference/noising/index.rst b/docs/source/api_reference/noising/index.rst index ff6d9ba2..9ff2ea7f 100644 --- a/docs/source/api_reference/noising/index.rst +++ b/docs/source/api_reference/noising/index.rst @@ -12,7 +12,7 @@ All of the dataset generation functions have the same (optional) parameters. Notable parameters include: - a `source` path to the root directory of pseudopeople input data (defaults to using the sample dataset included with pseudopeople). - - a `config` path to a YAML file or a Python dictionary to :ref:`override the default configuration `. + - a `config` path to a YAML file, a Python dictionary, or the special value :code:`pseudopeople.NO_NOISE`, to :ref:`override the default configuration `. - a `year` (defaults to 2020). For applied examples of using these functions, see the :ref:`Quickstart ` and :ref:`tutorials `. diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index 463f3b67..da9a596a 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -19,6 +19,9 @@ Due to this fine-grained control, there are a very large number of settings. **It is not necessary to configure everything.** pseudopeople includes reasonable default noise settings and your configuration can override as few or as many of the default values as you like. +You can also pass the special value :code:`pseudopeople.NO_NOISE`, which prevents all configurable noise types +from occurring at all. + To learn more about the default settings, see :ref:`Noise Type Details `. You can access the defaults from your Python code by calling the :func:`pseudopeople.get_config` function. @@ -87,7 +90,8 @@ How to pass configuration to pseudopeople Each of pseudopeople's :ref:`dataset generation functions ` takes a :code:`config` argument. -This argument can be passed either a Python dictionary or the path to a YAML file. +This argument can be passed either a Python dictionary, the path to a YAML file, or the special value +:code:`pseudopeople.NO_NOISE`, which prevents all configurable noise types from occurring at all. Configurable parameters -----------------------