Skip to content

API docs: fix typo in reference #1078

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.

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
Aug 6, 2024
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -688,7 +688,7 @@ Disabling severities allows the server to skip analysis for those, which can spe
Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.
Further, they are surfaced through :attr:`.ResultSummary.gql_status_objects`:
For GQL-aware servers, notifications are a subset of GqlStatusObjects.
See also :attr:`.GqlSatusObject.is_notification`.
See also :attr:`.GqlStatusObject.is_notification`.

:data:`None` will apply the server's default setting.

Expand All @@ -714,7 +714,7 @@ Disabling categories allows the server to skip analysis for those, which can spe

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.
Further, they are surfaced (alongside other status objects) through :attr:`.ResultSummary.gql_status_objects`:
See also :attr:`.GqlSatusObject.is_notification`.
See also :attr:`.GqlStatusObject.is_notification`.

:data:`None` will apply the server's default setting.

Expand Down Expand Up @@ -1188,7 +1188,7 @@ Disabling severities allows the server to skip analysis for those, which can spe

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.
Further, they are surfaced (alongside other status objects) through :attr:`.ResultSummary.gql_status_objects`:
See also :attr:`.GqlSatusObject.is_notification`.
See also :attr:`.GqlStatusObject.is_notification`.

:data:`None` will apply the driver's configuration setting (:ref:`driver-notifications-min-severity-ref`).

Expand All @@ -1214,7 +1214,7 @@ Disabling categories allows the server to skip analysis for those, which can spe

Notifications are available via :attr:`.ResultSummary.notifications` and :attr:`.ResultSummary.summary_notifications`.
Further, they are surfaced (alongside other status objects) through :attr:`.ResultSummary.gql_status_objects`:
See also :attr:`.GqlSatusObject.is_notification`.
See also :attr:`.GqlStatusObject.is_notification`.

:data:`None` will apply the driver's configuration setting (:ref:`driver-notifications-disabled-categories-ref`).

Expand Down