Skip to content

Docs: minor updates #1137

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
merged 2 commits into from
Jan 29, 2025
Merged

Docs: minor updates #1137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f459923
Fix API docs referencing a default that is not defined
robsdedude Jan 28, 2025
5036367
Fix type hints of internal functions
robsdedude Jan 28, 2025
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
10 changes: 4 additions & 6 deletions src/neo4j/_work/summary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ class SummaryInputPosition:
offset: int

@classmethod
def _from_metadata(cls, metadata: t.Any) -> te.Self | None:
def _from_metadata(cls, metadata: object) -> te.Self | None:
if not isinstance(metadata, dict):
return None
line = metadata.get("line")
Expand Down Expand Up @@ -515,7 +515,7 @@ class SummaryNotification:
position: SummaryNotificationPosition | None = None

@classmethod
def _from_metadata(cls, metadata: t.Any) -> te.Self:
def _from_metadata(cls, metadata: object) -> te.Self:
if not isinstance(metadata, dict):
return cls()
kwargs: _SummaryNotificationKwargs = {
Expand Down Expand Up @@ -631,7 +631,7 @@ def _no_data(cls) -> te.Self:
return obj

@classmethod
def _from_status_metadata(cls, metadata: t.Any) -> te.Self:
def _from_status_metadata(cls, metadata: object) -> te.Self:
obj = cls()
if isinstance(metadata, dict):
obj._status_metadata = metadata
Expand All @@ -640,7 +640,7 @@ def _from_status_metadata(cls, metadata: t.Any) -> te.Self:
return obj

@classmethod
def _from_notification_metadata(cls, metadata: t.Any) -> te.Self:
def _from_notification_metadata(cls, metadata: object) -> te.Self:
obj = cls()
if not isinstance(metadata, dict):
metadata = {}
Expand Down Expand Up @@ -805,8 +805,6 @@ def position(self) -> SummaryInputPosition | None:
The position of the input that caused the status (if applicable).

This is vendor-specific information.
If not provided, it defaults to :class:`SummaryInputPosition`'s
default.

Only notifications (see :attr:`.is_notification`) have a meaningful
position.
Expand Down