Fix most sphinx documentation warnings (#101228)

This commit is contained in:
Dave T 2023-10-02 08:01:41 +01:00 committed by GitHub
parent f2cf87b0b7
commit 99a76ef4e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 13 deletions

View File

@ -1,7 +1,7 @@
.. _data_entry_flow_module:
:mod:`homeassistant.data_entry_flow`
-----------------------------
------------------------------------
.. automodule:: homeassistant.data_entry_flow
:members:

View File

@ -214,14 +214,6 @@ homeassistant.helpers.location
:undoc-members:
:show-inheritance:
homeassistant.helpers.logging
-----------------------------
.. automodule:: homeassistant.helpers.logging
:members:
:undoc-members:
:show-inheritance:
homeassistant.helpers.network
-----------------------------

View File

@ -139,7 +139,7 @@ def linkcode_resolve(domain, info):
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:

View File

@ -72,7 +72,8 @@ class AbstractOAuth2Implementation(ABC):
Pass external data in with:
await hass.config_entries.flow.async_configure(
flow_id=flow_id, user_input={'code': 'abcd', 'state': { }
flow_id=flow_id, user_input={'code': 'abcd', 'state': }
)
"""

View File

@ -115,7 +115,7 @@ def json_bytes_strip_null(data: Any) -> bytes:
def json_dumps(data: Any) -> str:
"""Dump json string.
r"""Dump json string.
orjson supports serializing dataclasses natively which
eliminates the need to implement as_dict in many places
@ -124,7 +124,7 @@ def json_dumps(data: Any) -> str:
be serialized.
If it turns out to be a problem we can disable this
with option |= orjson.OPT_PASSTHROUGH_DATACLASS and it
with option \|= orjson.OPT_PASSTHROUGH_DATACLASS and it
will fallback to as_dict
"""
return json_bytes(data).decode("utf-8")