Skip to content

Naming#256

Merged
m7pr merged 1 commit into
teal_reportablefrom
naming@teal_reportable
Jun 6, 2025
Merged

Naming#256
m7pr merged 1 commit into
teal_reportablefrom
naming@teal_reportable

Conversation

@m7pr

@m7pr m7pr commented Jun 5, 2025

Copy link
Copy Markdown
Contributor

Companion to insightsengineering/teal.reporter#334
Consequence of changing naming convention for teal_report object.

@m7pr
m7pr requested review from averissimo and gogonzo June 5, 2025 13:53
@m7pr m7pr added the core label Jun 5, 2025
m7pr added a commit to insightsengineering/teal.reporter that referenced this pull request Jun 6, 2025
Changed names

- `teal_reporter@report` ->  `teal_reporter@teal_card`
- `teal.reporter::doc()` ->  `teal.reporter::teal_card()`
- `teal.reporter::report()` ->  `teal.reporter::teal_card()`

So now you can use

```r
data <- teal.reporter::teal_report()  # teal_report() class
data@teal_card                        # teal_card class
teal.reporter::teal_card(data)        # teal_card class
```

Also `teal_card` is the creator, the getter and the setter

```r
data <- teal.reporter::teal_report()
teal_card(data) <- teal_card()       # setter + creator
teal_card(data)                      # getter
data@teal_card                       # direct slot access
```

Companion to:
- insightsengineering/teal#1542
- insightsengineering/teal.modules.general#885
- insightsengineering/teal.code#256

---------

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>
Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>
Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>
@m7pr
m7pr merged commit 7959973 into teal_reportable Jun 6, 2025
1 check passed
@m7pr
m7pr deleted the naming@teal_reportable branch June 6, 2025 12:26
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants