<!--
{
  "availability" : [
    "iOS: 15.0.0 -",
    "iPadOS: 15.0.0 -",
    "macCatalyst: 15.0.0 -",
    "macOS: 12.0.0 -",
    "tvOS: 15.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 8.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "TabularData",
  "identifier" : "/documentation/TabularData/DataFrameProtocol/description(options:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "TabularData"
    ],
    "preciseIdentifier" : "s:11TabularData0B13FrameProtocolPAAE11description7optionsSSAA17FormattingOptionsV_tF"
  },
  "title" : "description(options:)"
}
-->

# description(options:)

Generates a text representation of the data frame type.

```
func description(options: FormattingOptions) -> String
```

## Parameters

`options`

A set of formatting options that affect the description string,
including the maximum width of a column and the maximum number of rows.

## Discussion

`FormattingOptions.maximumLineWidth` needs to be wide enough to print at least the index column, the truncation
column, and one data column (at least two characters, one for initial of the content, and one for “…”).

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)