Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add docstrings for new location methods #474

Merged
merged 24 commits into from
Oct 4, 2024
Merged

docs: Add docstrings for new location methods #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
b0edc73
Add docstring for LocSourceNotes
rich-iannone Sep 30, 2024
326e523
Add `loc.source_note` to API reference
rich-iannone Sep 30, 2024
3d3f708
Make correction to loc name
rich-iannone Sep 30, 2024
a203fbc
Revise text in some Loc* docstrings
rich-iannone Sep 30, 2024
6f7559f
Add docstring for LocColumnLabels
rich-iannone Sep 30, 2024
87f7407
Add loc.column_labels to API reference
rich-iannone Sep 30, 2024
e5255a9
Add loc.footer to API reference
rich-iannone Sep 30, 2024
9a9c3d6
Make correction to 'Returns' section in docstring
rich-iannone Sep 30, 2024
c4c281f
Add docstring for the LocTitle class
rich-iannone Sep 30, 2024
617ac10
Add docstring for LocSubTitle class
rich-iannone Sep 30, 2024
b807c14
Add docstring for LocHeader class
rich-iannone Sep 30, 2024
a453212
Add docstring for LocSpannerLabels class
rich-iannone Sep 30, 2024
d1a357c
Make adjustments to text introducing example
rich-iannone Sep 30, 2024
cc53a16
Add docstring for LocColumnHeader
rich-iannone Oct 1, 2024
45be9d1
Merge branch 'main' into docs-new-loc-docstrings
rich-iannone Oct 1, 2024
164cea6
Add docstring for LocStubheadLabel
rich-iannone Oct 1, 2024
0e91b1d
Document LocStubhead instead of LocStubheadLabel
rich-iannone Oct 1, 2024
4f14979
Add docstring for LocStub class
rich-iannone Oct 1, 2024
8c82aef
Add docstring for LocRowGroups class
rich-iannone Oct 1, 2024
c1fcebe
Add example to LocBody docstring
rich-iannone Oct 1, 2024
606cf68
Reorder loc methods in API reference
rich-iannone Oct 1, 2024
236a6d2
Add note about future 'footnotes' loc in LocFooter
rich-iannone Oct 1, 2024
e9fc9e3
Tweak docstring titles for Loc* classes
rich-iannone Oct 1, 2024
591b211
Merge branch 'main' into docs-new-loc-docstrings
rich-iannone Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/_quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,18 @@ quartodoc:
[`tab_style()`](`great_tables.GT.tab_style`) method). The styling classes allow for the
specification of the styling properties to be applied to the targeted locations.
contents:
- loc.header
- loc.title
- loc.subtitle
- loc.stubhead
- loc.column_header
- loc.spanner_labels
- loc.column_labels
- loc.stub
- loc.row_groups
- loc.body
- loc.footer
- loc.source_notes
- style.fill
- style.text
- style.borders
Expand Down
Loading
Loading