Skip to content

Commit 1d27b34

Browse files
committed
Add/fix docstrings
1 parent 31321e1 commit 1d27b34

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

google/api_core/_python_package_support.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,11 @@ def warn_deprecation_for_versions_less_than(
7272
pinned to a version lower than `next_supported_version`.
7373
7474
Args:
75-
dependent_package: The distribution name of the package that needs `dependency_name`.
75+
dependent_package: The distribution name of the package that
76+
needs `dependency_name`.
7677
dependency_name: The distribution name oft he dependency to check.
77-
next_supported_version: The version number below which a deprecation warning will be logged.
78+
next_supported_version: The version number below which a deprecation
79+
warning will be logged.
7880
message_template: A custom default message template to replace
7981
the default. This `message_template` is treated as an
8082
f-string, where the following variables are defined:
@@ -111,6 +113,17 @@ def warn_deprecation_for_versions_less_than(
111113

112114

113115
def check_dependency_versions(dependent_package: str):
116+
"""Bundle checks for all package dependencies.
117+
118+
This function can be called by all depndents of google.api_core,
119+
to emit needed deprecation warnings for any of their
120+
dependencies. The dependencies to check should be updated here.
121+
122+
Args:
123+
dependent_package: The distribution name of the calling package, whose
124+
dependencies we're checking.
125+
126+
"""
114127
warn_deprecation_for_versions_less_than(
115128
dependent_package, "protobuf (google.protobuf)", "4.25.8"
116129
)

0 commit comments

Comments
 (0)