Skip to content

Commit

Permalink
Fix typos (#11936)
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Turner <[email protected]>
  • Loading branch information
tk0miya and AA-Turner authored Oct 5, 2024
1 parent 09ab6ed commit 9323de2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
6 changes: 3 additions & 3 deletions sphinx/ext/autodoc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2507,7 +2507,7 @@ def is_uninitialized_instance_attribute(self, parent: Any) -> bool:
return self.objpath[-1] in annotations

def import_object(self, raiseerror: bool = False) -> bool:
"""Check the exisitence of uninitialized instance attribute when failed to import
"""Check the existence of uninitialized instance attribute when failed to import
the attribute.
"""
try:
Expand Down Expand Up @@ -2728,7 +2728,7 @@ def can_document_member(
return False

def import_object(self, raiseerror: bool = False) -> bool:
"""Check the exisitence of uninitialized instance attribute when failed to import
"""Check the existence of uninitialized instance attribute when failed to import
the attribute.
"""
ret = super().import_object(raiseerror)
Expand Down Expand Up @@ -2801,7 +2801,7 @@ def _get_property_getter(self) -> Callable | None:

def autodoc_attrgetter(app: Sphinx, obj: Any, name: str, *defargs: Any) -> Any:
"""Alternative getattr() for types"""
for typ, func in app.registry.autodoc_attrgettrs.items():
for typ, func in app.registry.autodoc_attrgetters.items():
if isinstance(obj, typ):
return func(obj, name, *defargs)

Expand Down
10 changes: 7 additions & 3 deletions sphinx/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
class SphinxComponentRegistry:
def __init__(self) -> None:
#: special attrgetter for autodoc; class object -> attrgetter
self.autodoc_attrgettrs: dict[type, Callable[[Any, str, Any], Any]] = {}
self.autodoc_attrgetters: dict[type, Callable[[Any, str, Any], Any]] = {}

#: builders; a dict of builder name -> builder class
self.builders: dict[str, type[Builder]] = {}
Expand Down Expand Up @@ -113,7 +113,7 @@ def __init__(self) -> None:
#: post transforms; list of transforms
self.post_transforms: list[type[Transform]] = []

#: source paresrs; file type -> parser class
#: source parsers; file type -> parser class
self.source_parsers: dict[str, type[Parser]] = {}

#: source suffix: suffix -> file type
Expand All @@ -132,6 +132,10 @@ def __init__(self) -> None:
# private cache of Docutils Publishers (file type -> publisher object)
self.publishers: dict[str, Publisher] = {}

@property
def autodoc_attrgettrs(self) -> dict[type, Callable[[Any, str, Any], Any]]:
return self.autodoc_attrgetters

def add_builder(self, builder: type[Builder], override: bool = False) -> None:
logger.debug('[app] adding builder: %r', builder)
if not hasattr(builder, 'name'):
Expand Down Expand Up @@ -377,7 +381,7 @@ def add_documenter(self, objtype: str, documenter: type[Documenter]) -> None:

def add_autodoc_attrgetter(self, typ: type,
attrgetter: Callable[[Any, str, Any], Any]) -> None:
self.autodoc_attrgettrs[typ] = attrgetter
self.autodoc_attrgetters[typ] = attrgetter

def add_css_files(self, filename: str, **attributes: Any) -> None:
self.css_files.append((filename, attributes))
Expand Down

0 comments on commit 9323de2

Please sign in to comment.