Skip to content

Commit 57981d2

Browse files
DOC: fix PR07,RT03,SA01,ES01 for pandas.io.json.build_table_schema (#60571)
1 parent 43ed81f commit 57981d2

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9595
-i "pandas.core.resample.Resampler.var SA01" \
9696
-i "pandas.errors.UndefinedVariableError PR01,SA01" \
9797
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
98-
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
9998
-i "pandas.plotting.andrews_curves RT03,SA01" \
10099
-i "pandas.tseries.offsets.BDay PR02,SA01" \
101100
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \

pandas/io/json/_table_schema.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,16 @@ def build_table_schema(
239239
"""
240240
Create a Table schema from ``data``.
241241
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+
242248
Parameters
243249
----------
244-
data : Series, DataFrame
250+
data : Series or DataFrame
251+
The input data for which the table schema is to be created.
245252
index : bool, default True
246253
Whether to include ``data.index`` in the schema.
247254
primary_key : bool or None, default True
@@ -256,6 +263,12 @@ def build_table_schema(
256263
Returns
257264
-------
258265
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.
259272
260273
Notes
261274
-----

0 commit comments

Comments
 (0)