Skip to content

Commit

Permalink
Add docstring for Boxhead class
Browse files Browse the repository at this point in the history
  • Loading branch information
rich-iannone committed Nov 21, 2024
1 parent ed2fa96 commit f61f662
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions great_tables/_gt_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,16 @@ def defaulted_align(self) -> str:


class Boxhead(_Sequence[ColInfo]):
"""Map columns of the input table to their final rendered placement in the boxhead.
The boxhead is the part of the table that contains the column labels and the stub head. This
class is responsible for the following:
- rendered boxhead: column order, labels, alignment, and visibility
- rendered body: alignment of data values for each column
- rendered stub: this class records which input column is used for the stub
"""

_d: list[ColInfo]

def __new__(
Expand Down

0 comments on commit f61f662

Please sign in to comment.