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.

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

Assess id argument in init() #1438

Closed
donyunardi opened this issue Dec 20, 2024 · 2 comments
Closed

Assess id argument in init() #1438

donyunardi opened this issue Dec 20, 2024 · 2 comments
Assignees
Labels

Comments

@donyunardi
Copy link
Contributor

Summary

We need to evaluate whether the id argument is still necessary given recent improvements to make teal a modular framework:

As noted in the documentation, the id argument is currently a legacy feature:

teal/R/init.R

Lines 31 to 33 in 997da60

#' @param id (`character`) Optionally,
#' a string specifying the `shiny` module id in cases it is used as a `shiny` module
#' rather than a standalone `shiny` app. This is a legacy feature.

Acceptance Criteria

  • Assess whether the id argument should be retained or removed.
  • If removal is needed, initiate the soft-deprecation process.
  • Update the documentation (roxygen and vignette) to reflect any changes.
@donyunardi donyunardi changed the title Deprecate id argument in init() Assess id argument in init() Dec 20, 2024
@gogonzo gogonzo self-assigned this Jan 10, 2025
@gogonzo
Copy link
Contributor

gogonzo commented Jan 13, 2025

id argument is not needed anymore since introduction of ui/srv_teal in #669. Instead of id in teal::init one can call modules directly instead of indirectly set id.

@m7pr
Copy link
Contributor

m7pr commented Jan 15, 2025

CC @donyunardi

gogonzo added a commit that referenced this issue Jan 15, 2025
- deprecate id in init #1438  
- fixing (wrong) id documentation in inherited docs. Please notice that
methods were inheriting `id` documentation from init. It means that all
modules had a wrong description.
@gogonzo gogonzo closed this as completed Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants