----------------------------------------------------------------------
This is the API documentation for the gdtest_tbl_shortcode library.
----------------------------------------------------------------------


## Functions

Public functions


describe(name: str) -> str

Describe a dataset by name.

Parameters
----------
name
    The dataset name.

Returns
-------
str
    A human-readable description.


----------------------------------------------------------------------
This is the User Guide documentation for the package.
----------------------------------------------------------------------

## Default Preview

The simplest usage — just point at a CSV file:

{{< tbl-preview file="assets/students.csv" >}}

## With Caption

Add a descriptive caption:

{{< tbl-preview file="assets/students.csv" caption="Student Scores — Fall 2025" >}}

## Column Subset

Show only selected columns:

{{< tbl-preview file="assets/students.csv" columns="name,score,grade" show_all="true" >}}


## Product Inventory

Tab-delimited files work just the same:

{{< tbl-preview file="assets/products.tsv" show_all="true" >}}

## Head Only

Show just the first 3 rows:

{{< tbl-preview file="assets/products.tsv" n_head="3" n_tail="0" >}}


## Server Logs

JSONL (newline-delimited JSON) files are auto-detected:

{{< tbl-preview file="assets/server_logs.jsonl" show_all="true" >}}

## With Narrow Columns

Constrain column widths to see truncation:

{{< tbl-preview file="assets/server_logs.jsonl" show_all="true" max_col_width="120" >}}


## Show All Rows

{{< tbl-preview file="assets/students.csv" show_all="true" >}}

## Custom Head/Tail Split

{{< tbl-preview file="assets/students.csv" n_head="3" n_tail="2" >}}

## Hide Row Numbers

{{< tbl-preview file="assets/students.csv" show_all="true" show_row_numbers="false" >}}

## Hide Dtype Labels

{{< tbl-preview file="assets/students.csv" show_all="true" show_dtypes="false" >}}

## Hide Dimensions Banner

{{< tbl-preview file="assets/students.csv" show_all="true" show_dimensions="false" >}}

## Minimal Chrome

No row numbers, no dtypes, no dimensions — just the data:

{{< tbl-preview file="assets/students.csv" show_all="true" show_row_numbers="false" show_dtypes="false" show_dimensions="false" >}}


## Side-by-Side Comparisons

Multiple shortcodes on one page, each with different files:

### Students (CSV)

{{< tbl-preview file="assets/students.csv" n_head="3" n_tail="0" caption="Top 3 Students" >}}

### Products (TSV)

{{< tbl-preview file="assets/products.tsv" n_head="3" n_tail="0" caption="Top 3 Products" >}}

### Server Logs (JSONL)

{{< tbl-preview file="assets/server_logs.jsonl" n_head="3" n_tail="0" caption="Recent Logs" >}}

## Wide Table

A 13-column metrics table with horizontal scroll:

{{< tbl-preview file="assets/wide_metrics.csv" show_all="true" caption="Monthly Metrics 2025" >}}