Ci/run doctests

[Flix6x]

Description

• The CI now runs the doctests in our utils subpackage
• The CI now runs the doctests in our data/schemas subpackage
• Added changelog item in documentation/changelog.rst

Look & Feel

Here's an example doctest we have:

def parameterize(word):
    """Parameterize the word, so it can be used as a Python or JavaScript variable name.
    For example:
    >>> parameterize("Acme® EV-Charger™")
    'acme_ev_chargertm'
    """
    return inflection.parameterize(word).replace("-", "_")

How to test

The CI takes care of this.

Further Improvements

Some of our other subpackages have some doctests, too. Some of them require app contexts and I couldn't get that to work easily. Most of them also appear to be meant more like an example than as a unit test. I usually only made use of doctests as unit tests for util functions.

[nhoening]

Why are we not actually running the doctests you have fixed here in these two modules?

• data/models/data_sources
• data/services/utils

[Flix6x]

Why are we not actually running the doctests you have fixed here in these two modules?

• data/models/data_sources
• data/services/utils

One is actually passing, but the other is just serving as an example. In general, some of our docstrings contain examples that can't actually run without an app context.

Should I add a CI step for just the one extra docstring that is passing as a doctest?

[nhoening]

Should I add a CI step for just the one extra docstring that is passing as a doctest?

No, only if we might add some more there.

[Flix6x]

Any other changes requested, or would you approve this PR?

[nhoening]

I approve

He approves.