Use ruff rule D417 to find some misstakes in the docs
Author: mosc9575Created Sep 6, 2026Updated Sep 6, 2026
Labelstag: component: docs
When running ruff rule D417. I can see some more problems in the docs.
E.g. Missing argument description in the docstring for `envset`: `**kw` --> tests\support\\\util\env.py:41:5
In this example the : sign is missing in the docstring after the parameters.
The actual docstring is this:
''' Match a host string against a pattern
Args:
host (str)
A hostname to compare to the given pattern
pattern (str)
A string representing a hostname pattern, possibly including
wildcards for ip address octets or ports.
'''Another example is Missing argument description in the docstring for `force`: `f` --> src\bokeh\driving.py:122:5
The actual docstring is this:
''' Return a decorator that can "force" a function with an arbitrary
supplied generator
Args:
sequence (iterable) :
generator to drive f with
Returns:
decorator
'''Here the parameter f is undocumented.
Originally posted by @mosc9575 in https://github.com/bokeh/bokeh/issues/15316#issuecomment-5278015923
Source: bokeh/bokeh