jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 03:07:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix most sphinx documentation warnings (#101228)

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/api/data_entry_flow.rst
View File

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

8
docs/source/api/helpers.rst
View File

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

2
docs/source/conf.py
View File

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

3
homeassistant/helpers/config_entry_oauth2_flow.py
View File

@ -72,7 +72,8 @@ class AbstractOAuth2Implementation(ABC):
Pass external data in with: Pass external data in with:
await hass.config_entries.flow.async_configure( 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': … }
) )
""" """

4
homeassistant/helpers/json.py
View File

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