15five / django-scim2 / 34238275296

90%

main: 90%

Pull #237

github

Fix broken field docs and document missing settings

The RFC-quote docstrings in models.py sit above their fields instead of
below them, so Sphinx autodoc never attaches them to the right
attribute. Built the docs locally to confirm: scim_external_id,
scim_username, and scim_display_name never rendered at all, and
scim_id showed the wrong text. Moving each docstring below its field
fixes this.

Also document USER_MODEL_GETTER, GET_IS_AUTHENTICATED_PREDICATE, and
AUTH_CHECK_MIDDLEWARE in docs/settings.rst -- the latter two are named
in the README ("see GET_IS_AUTHENTICATED_PREDICATE for details") but
were never actually documented. Add a short pointer to the demo app in
the README so new users can find the working example.

Relates to #144.

141 of 182 branches covered (77.47%)

Branch coverage included in aggregate %.

4 of 4 new or added lines in 1 file covered. (100.0%)

808 of 875 relevant lines covered (92.34%)

0.92 hits per line