Skip to content

MNT: Cleanup docstring substitution mechanisms #28795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ksunden merged 2 commits into from
Sep 30, 2024
Merged

MNT: Cleanup docstring substitution mechanisms #28795

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f855a6
MNT: Make Substitution and _ArtistPropertiesSubstitution independent
timhoffm Sep 9, 2024
fe9479a
Rename _ArtistPropertiesSubstitution.update() to register()
timhoffm Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
MNT: Make Substitution and _ArtistPropertiesSubstitution independent 
They do not have relevant functional overlap. Thus, it's simpler
to keep them completely separated.
  • Loading branch information
@timhoffm
timhoffm committed Sep 21, 2024
commit 8f855a6904bfb5be970d4faaba78d1e9e8fba364
17 changes: 9 additions & 8 deletions lib/matplotlib/_docstring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ def __call__(self, func):
func.__doc__ = inspect.cleandoc(func.__doc__) % self.params
return func

def update(self, *args, **kwargs):
"""
Update ``self.params`` (which must be a dict) with the supplied args.
"""
self.params.update(*args, **kwargs)


class _ArtistKwdocLoader(dict):
def __missing__(self, key):
Expand All @@ -89,7 +83,7 @@ def __missing__(self, key):
return self.setdefault(key, kwdoc(cls))


class _ArtistPropertiesSubstitution(Substitution):
class _ArtistPropertiesSubstitution:
"""
A `.Substitution` with two additional features:

Expand All @@ -104,8 +98,15 @@ class _ArtistPropertiesSubstitution(Substitution):
def __init__(self):
self.params = _ArtistKwdocLoader()

def update(self, *args, **kwargs):
"""
Update ``self.params`` (which must be a dict) with the supplied args.
"""
self.params.update(*args, **kwargs)

def __call__(self, obj):
super().__call__(obj)
if obj.__doc__:
obj.__doc__ = inspect.cleandoc(obj.__doc__) % self.params
if isinstance(obj, type) and obj.__init__ != object.__init__:
self(obj.__init__)
return obj
Expand Down
3 changes: 2 additions & 1 deletion lib/matplotlib/_docstring.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ class _ArtistKwdocLoader(dict[str, str]):
def __missing__(self, key: str) -> str: ...


class _ArtistPropertiesSubstitution(Substitution):
class _ArtistPropertiesSubstitution:
def __init__(self) -> None: ...
def update(self, *args, **kwargs) -> None:
def __call__(self, obj: _T) -> _T: ...


Expand Down