Skip to content

Commit f7b0ee4

Browse files
docs: fix formatting of generated client docstrings (#1009)
chore: fix docstring for first attribute of protos committer: @busunkim96 PiperOrigin-RevId: 401271153 Source-Link: googleapis/googleapis@787f8c9 Source-Link: googleapis/googleapis-gen@81decff Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Tim Swast <[email protected]>
1 parent c8124e9 commit f7b0ee4

File tree

5 files changed

+34
-2
lines changed

5 files changed

+34
-2
lines changed

google/cloud/bigquery_v2/types/encryption_config.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525

2626
class EncryptionConfiguration(proto.Message):
2727
r"""
28+
2829
Attributes:
2930
kms_key_name (google.protobuf.wrappers_pb2.StringValue):
3031
Optional. Describes the Cloud KMS encryption

google/cloud/bigquery_v2/types/model.py

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838

3939
class Model(proto.Message):
4040
r"""
41+
4142
Attributes:
4243
etag (str):
4344
Output only. A hash of this resource.
@@ -251,7 +252,8 @@ class FeedbackType(proto.Enum):
251252
EXPLICIT = 2
252253

253254
class SeasonalPeriod(proto.Message):
254-
r""" """
255+
r"""
256+
"""
255257

256258
class SeasonalPeriodType(proto.Enum):
257259
r""""""
@@ -264,7 +266,8 @@ class SeasonalPeriodType(proto.Enum):
264266
YEARLY = 6
265267

266268
class KmeansEnums(proto.Message):
267-
r""" """
269+
r"""
270+
"""
268271

269272
class KmeansInitializationMethod(proto.Enum):
270273
r"""Indicates the method used to initialize the centroids for
@@ -386,6 +389,7 @@ class BinaryClassificationMetrics(proto.Message):
386389

387390
class BinaryConfusionMatrix(proto.Message):
388391
r"""Confusion matrix for binary classification models.
392+
389393
Attributes:
390394
positive_class_threshold (google.protobuf.wrappers_pb2.DoubleValue):
391395
Threshold value used when computing each of
@@ -464,6 +468,7 @@ class MultiClassClassificationMetrics(proto.Message):
464468

465469
class ConfusionMatrix(proto.Message):
466470
r"""Confusion matrix for multi-class classification models.
471+
467472
Attributes:
468473
confidence_threshold (google.protobuf.wrappers_pb2.DoubleValue):
469474
Confidence threshold used when computing the
@@ -474,6 +479,7 @@ class ConfusionMatrix(proto.Message):
474479

475480
class Entry(proto.Message):
476481
r"""A single entry in the confusion matrix.
482+
477483
Attributes:
478484
predicted_label (str):
479485
The predicted label. For confidence_threshold > 0, we will
@@ -491,6 +497,7 @@ class Entry(proto.Message):
491497

492498
class Row(proto.Message):
493499
r"""A single row in the confusion matrix.
500+
494501
Attributes:
495502
actual_label (str):
496503
The original label of this row.
@@ -525,6 +532,7 @@ class Row(proto.Message):
525532

526533
class ClusteringMetrics(proto.Message):
527534
r"""Evaluation metrics for clustering models.
535+
528536
Attributes:
529537
davies_bouldin_index (google.protobuf.wrappers_pb2.DoubleValue):
530538
Davies-Bouldin index.
@@ -537,6 +545,7 @@ class ClusteringMetrics(proto.Message):
537545

538546
class Cluster(proto.Message):
539547
r"""Message containing the information about one cluster.
548+
540549
Attributes:
541550
centroid_id (int):
542551
Centroid id.
@@ -550,6 +559,7 @@ class Cluster(proto.Message):
550559

551560
class FeatureValue(proto.Message):
552561
r"""Representative value of a single feature within the cluster.
562+
553563
Attributes:
554564
feature_column (str):
555565
The feature column name.
@@ -562,6 +572,7 @@ class FeatureValue(proto.Message):
562572

563573
class CategoricalValue(proto.Message):
564574
r"""Representative value of a categorical feature.
575+
565576
Attributes:
566577
category_counts (Sequence[google.cloud.bigquery_v2.types.Model.ClusteringMetrics.Cluster.FeatureValue.CategoricalValue.CategoryCount]):
567578
Counts of all categories for the categorical feature. If
@@ -573,6 +584,7 @@ class CategoricalValue(proto.Message):
573584

574585
class CategoryCount(proto.Message):
575586
r"""Represents the count of a single category within the cluster.
587+
576588
Attributes:
577589
category (str):
578590
The name of category.
@@ -668,6 +680,7 @@ class RankingMetrics(proto.Message):
668680

669681
class ArimaForecastingMetrics(proto.Message):
670682
r"""Model evaluation metrics for ARIMA forecasting models.
683+
671684
Attributes:
672685
non_seasonal_order (Sequence[google.cloud.bigquery_v2.types.Model.ArimaOrder]):
673686
Non-seasonal order.
@@ -857,6 +870,7 @@ class ArimaOrder(proto.Message):
857870

858871
class ArimaFittingMetrics(proto.Message):
859872
r"""ARIMA model fitting metrics.
873+
860874
Attributes:
861875
log_likelihood (float):
862876
Log-likelihood.
@@ -888,6 +902,7 @@ class GlobalExplanation(proto.Message):
888902

889903
class Explanation(proto.Message):
890904
r"""Explanation for a single feature.
905+
891906
Attributes:
892907
feature_name (str):
893908
Full name of the feature. For non-numerical features, will
@@ -910,6 +925,7 @@ class Explanation(proto.Message):
910925

911926
class TrainingRun(proto.Message):
912927
r"""Information about a single training query run for the model.
928+
913929
Attributes:
914930
training_options (google.cloud.bigquery_v2.types.Model.TrainingRun.TrainingOptions):
915931
Options that were used for this training run,
@@ -935,6 +951,7 @@ class TrainingRun(proto.Message):
935951

936952
class TrainingOptions(proto.Message):
937953
r"""Options used in model training.
954+
938955
Attributes:
939956
max_iterations (int):
940957
The maximum number of iterations in training.
@@ -1182,6 +1199,7 @@ class TrainingOptions(proto.Message):
11821199

11831200
class IterationResult(proto.Message):
11841201
r"""Information about a single iteration of the training run.
1202+
11851203
Attributes:
11861204
index (google.protobuf.wrappers_pb2.Int32Value):
11871205
Index of the iteration, 0 based.
@@ -1205,6 +1223,7 @@ class IterationResult(proto.Message):
12051223

12061224
class ClusterInfo(proto.Message):
12071225
r"""Information about a single cluster for clustering model.
1226+
12081227
Attributes:
12091228
centroid_id (int):
12101229
Centroid id.
@@ -1241,6 +1260,7 @@ class ArimaResult(proto.Message):
12411260

12421261
class ArimaCoefficients(proto.Message):
12431262
r"""Arima coefficients.
1263+
12441264
Attributes:
12451265
auto_regressive_coefficients (Sequence[float]):
12461266
Auto-regressive coefficients, an array of
@@ -1263,6 +1283,7 @@ class ArimaCoefficients(proto.Message):
12631283

12641284
class ArimaModelInfo(proto.Message):
12651285
r"""Arima model information.
1286+
12661287
Attributes:
12671288
non_seasonal_order (google.cloud.bigquery_v2.types.Model.ArimaOrder):
12681289
Non-seasonal order.
@@ -1409,6 +1430,7 @@ class ArimaModelInfo(proto.Message):
14091430

14101431
class GetModelRequest(proto.Message):
14111432
r"""
1433+
14121434
Attributes:
14131435
project_id (str):
14141436
Required. Project ID of the requested model.
@@ -1425,6 +1447,7 @@ class GetModelRequest(proto.Message):
14251447

14261448
class PatchModelRequest(proto.Message):
14271449
r"""
1450+
14281451
Attributes:
14291452
project_id (str):
14301453
Required. Project ID of the model to patch.
@@ -1447,6 +1470,7 @@ class PatchModelRequest(proto.Message):
14471470

14481471
class DeleteModelRequest(proto.Message):
14491472
r"""
1473+
14501474
Attributes:
14511475
project_id (str):
14521476
Required. Project ID of the model to delete.
@@ -1463,6 +1487,7 @@ class DeleteModelRequest(proto.Message):
14631487

14641488
class ListModelsRequest(proto.Message):
14651489
r"""
1490+
14661491
Attributes:
14671492
project_id (str):
14681493
Required. Project ID of the models to list.
@@ -1487,6 +1512,7 @@ class ListModelsRequest(proto.Message):
14871512

14881513
class ListModelsResponse(proto.Message):
14891514
r"""
1515+
14901516
Attributes:
14911517
models (Sequence[google.cloud.bigquery_v2.types.Model]):
14921518
Models in the requested dataset. Only the following fields

google/cloud/bigquery_v2/types/model_reference.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
class ModelReference(proto.Message):
2525
r"""Id path of a model.
26+
2627
Attributes:
2728
project_id (str):
2829
Required. The ID of the project containing

google/cloud/bigquery_v2/types/standard_sql.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ class TypeKind(proto.Enum):
7878

7979
class StandardSqlField(proto.Message):
8080
r"""A field or a column.
81+
8182
Attributes:
8283
name (str):
8384
Optional. The name of this field. Can be
@@ -96,6 +97,7 @@ class StandardSqlField(proto.Message):
9697

9798
class StandardSqlStructType(proto.Message):
9899
r"""
100+
99101
Attributes:
100102
fields (Sequence[google.cloud.bigquery_v2.types.StandardSqlField]):
101103
@@ -106,6 +108,7 @@ class StandardSqlStructType(proto.Message):
106108

107109
class StandardSqlTableType(proto.Message):
108110
r"""A table type
111+
109112
Attributes:
110113
columns (Sequence[google.cloud.bigquery_v2.types.StandardSqlField]):
111114
The columns in this table type

google/cloud/bigquery_v2/types/table_reference.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
class TableReference(proto.Message):
2525
r"""
26+
2627
Attributes:
2728
project_id (str):
2829
Required. The ID of the project containing

0 commit comments

Comments
 (0)