Wwdtm

=====

Application Changes
-------------------

* Added ``number_decimal_places`` optional parameter the following methods with a default value of 5

* :py:meth:`wwdtm.panelist.Panelist.retrieve_all_details`
* :py:meth:`wwdtm.panelist.Panelist.retrieve_details_by_id`
* :py:meth:`wwdtm.panelist.Panelist.retrieve_details_by_slug`
* :py:meth:`wwdtm.panelist.Panelist.retrieve_random_details`

* Renamed functions, methods and parameters for clarity regarding the number of number of decimal places to round to for panelist statistics

* Renamed ``number_digits`` parameter to ``number_decimal_places`` for :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id` and :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id`
* Renamed :py:meth:`wwdtm.validation.valid_rounding_digits` to :py:meth:`wwdtm.validation.valid_rounding_decimal_places` and updated parameter names to match

Development Changes
-------------------

* Added new permutations of tests for the recently and newly added functions and methods
* Updated tests to reflect the new functions or mathod names, along with parameter names

=====

Application Changes
-------------------

* Added ``number_digits`` parameter to :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id` and :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id` to set the number of digits after the decimal separator to round to

* Default value of the parameter is ``5``
* Minimum and maximum supported values for the parameter is ``0`` and ``20``
* If an invalid value is passed in, the method will return an empty dictionary

* Added :py:meth:`wwdtm.validation.valid_rounding_digits` that is used to validate the ``number_digits`` value using the above minimum and maximum values

Development Changes
-------------------

* Added positive and negative tests for :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id`, :py:meth:`wwdtm.panelist.PanelistStatistics.retrieve_statistics_by_id`, and :py:meth:`wwdtm.validation.valid_rounding_digits`

=====

Application Changes
-------------------

* The library now requires panelist decimal score columns in the Wait Wait Stats Database and removed all instances of the ``include_decimal_scores`` and ``use_decimal_scores`` named parameters.

* Since this is a breaking change and the library tries to follow the SemVer format, this is being done as a brand new major version

* Added ``__all__`` entries to each of the ``__init__.py`` files for the guest, host, location, panelist, pronoun, scorekeeper and show modules
* Added :py:meth:`wwdtm.validation.check_database_version` that can be used to check if the Wait Wait Stats Database being used meets the minimum required version, ``4.7.0``.

Development Changes
-------------------

* Added pydoclint 0.8.4
* Added test for :py:func:`wwdtm.database_version` that passes through a database connection object
* Removed ``F401`` from ``tool.ruff.lint.ignore`` from ``pyproject.toml``
* Updated several entries in ``pyproject.toml`` including Project URLs and Classifiers

Documentation Changes
---------------------

* Added missing document page for ``tests/test_init.py``
* Removed unnecessary docstrings for the ``__init__()`` methods
* Replaced Google Fonts with Bunny Fonts as the web font provider for the required IBM Plex fonts

* For documentation hosted on Read the Docs, this will only apply starting with version 3.0.0. Previous versions will continue to use Google Fonts to source web fonts.

======================

Development Changes
-------------------

* Added pydoclint 0.8.4
* Added test for :py:func:`wwdtm.database_version` that passes through a database connection object

Documentation Changes
---------------------

* Added missing document page for ``tests/test_init.py``
* Removed unnecessary docstrings for the ``__init__()`` methods

========================

Development Changes
-------------------

* Updated several entries in ``pyproject.toml`` including Project URLs and Classifiers

=========================

Application Changes
-------------------

* The library now requires panelist decimal score columns in the Wait Wait Stats Database and removed all instances of the ``include_decimal_scores`` and ``use_decimal_scores`` named parameters.

* Since this is a breaking change and the library tries to follow the SemVer format, this is being done as a brand new major version

* Added ``__all__`` entries to each of the ``__init__.py`` files for the guest, host, location, panelist, pronoun, scorekeeper and show modules
* Added :py:meth:`wwdtm.validation.check_database_version` that can be used to check if the Wait Wait Stats Database being used meets the minimum required version, ``4.7.0``.

Development Changes
-------------------

* Removed ``F401`` from ``tool.ruff.lint.ignore`` from ``pyproject.toml``