File tree Expand file tree Collapse file tree 2 files changed +14
-2
lines changed Expand file tree Collapse file tree 2 files changed +14
-2
lines changed Original file line number Diff line number Diff line change @@ -95,7 +95,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
95
95
-i " pandas.core.resample.Resampler.var SA01" \
96
96
-i " pandas.errors.UndefinedVariableError PR01,SA01" \
97
97
-i " pandas.errors.ValueLabelTypeMismatch SA01" \
98
- -i " pandas.io.json.build_table_schema PR07,RT03,SA01" \
99
98
-i " pandas.plotting.andrews_curves RT03,SA01" \
100
99
-i " pandas.tseries.offsets.BDay PR02,SA01" \
101
100
-i " pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
Original file line number Diff line number Diff line change @@ -239,9 +239,16 @@ def build_table_schema(
239
239
"""
240
240
Create a Table schema from ``data``.
241
241
242
+ This method is a utility to generate a JSON-serializable schema
243
+ representation of a pandas Series or DataFrame, compatible with the
244
+ Table Schema specification. It enables structured data to be shared
245
+ and validated in various applications, ensuring consistency and
246
+ interoperability.
247
+
242
248
Parameters
243
249
----------
244
- data : Series, DataFrame
250
+ data : Series or DataFrame
251
+ The input data for which the table schema is to be created.
245
252
index : bool, default True
246
253
Whether to include ``data.index`` in the schema.
247
254
primary_key : bool or None, default True
@@ -256,6 +263,12 @@ def build_table_schema(
256
263
Returns
257
264
-------
258
265
dict
266
+ A dictionary representing the Table schema.
267
+
268
+ See Also
269
+ --------
270
+ DataFrame.to_json : Convert the object to a JSON string.
271
+ read_json : Convert a JSON string to pandas object.
259
272
260
273
Notes
261
274
-----
You can’t perform that action at this time.
0 commit comments