From 7b80483f728589c2672107b6817832e6dea5cbd3 Mon Sep 17 00:00:00 2001 From: Thor Whalen <1906276+thorwhalen@users.noreply.github.com> Date: Tue, 15 Sep 2026 11:54:14 +0200 Subject: [PATCH] docs: replace the last three repair-made rubrics and one literal block with prose epythet repair (tracked in i2mint/epythet#27) turned Google 'Example(s):' headers into .. rubric:: lines and a 'specifying:' + indented paragraph into a literal block. --- i2/signatures.py | 10 +++++----- i2/util.py | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/i2/signatures.py b/i2/signatures.py index 3df5101d..6948d079 100644 --- a/i2/signatures.py +++ b/i2/signatures.py @@ -696,12 +696,12 @@ def extract_arguments( If you're expecting no remainder you might want to just get the args and kwargs ( not this third - expected-to-be-empty remainder). You have two ways to do that, specifying:: + expected-to-be-empty remainder). You have two ways to do that, specifying: - `what_to_do_with_remainding='ignore'`, which will just return the (args, - kwargs) pair - `what_to_do_with_remainding='assert_empty'`, which will do the same, but first - assert the remainder is empty + - `what_to_do_with_remainding='ignore'`, which will just return the (args, + kwargs) pair + - `what_to_do_with_remainding='assert_empty'`, which will do the same, but first + assert the remainder is empty We suggest to use `functools.partial` to configure the `argument_argument` you need. diff --git a/i2/util.py b/i2/util.py index f22355b8..9ec30c5f 100644 --- a/i2/util.py +++ b/i2/util.py @@ -217,7 +217,7 @@ class ConditionalExceptionCatcher: :param prevent_propagation: Whether to prevent the exception from propagating. Defaults to ``True``. - .. rubric:: Example + **Example** >>> exception_catcher = ConditionalExceptionCatcher( ... ValueError, lambda e: e.args[0] == 'foo', handlers=print @@ -285,7 +285,7 @@ class AttributeMapping(SimpleNamespace, Mapping[str, Any]): Useful when you want mapping interface but don't need mutation. - .. rubric:: Examples + **Examples** >>> ns = AttributeMapping(x=10, y=20) >>> ns.x @@ -326,7 +326,7 @@ class AttributeMutableMapping(AttributeMapping, MutableMapping[str, Any]): Extends AttributeMapping with mutation capabilities, ensuring proper error handling and protocol compliance. - .. rubric:: Examples + **Examples** >>> ns = AttributeMutableMapping(apple=1, banana=2) >>> ns.apple