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

Write a new vignette about teal_data #174

Closed
5 tasks done
gogonzo opened this issue Oct 5, 2023 · 6 comments · Fixed by #205
Closed
5 tasks done

Write a new vignette about teal_data #174

gogonzo opened this issue Oct 5, 2023 · 6 comments · Fixed by #205

Comments

@gogonzo
Copy link
Contributor

gogonzo commented Oct 5, 2023

Since TealData is deprecated, we should no longer teach in the vignettes about this class. So we have (at least) two altnernative solutions:

  • remove vignettes describing all (unwanted) ways of specifying data
  • state in the old vignettes that their content is deprecated

There should be new vignettes:

  • teal_data class and it's methods and idea behind @gogonzo
  • Reproducibility check
  • join_keys vignette #202
  • using teal_data in teal application (this should be in teal)
  • how to migrate from TealData to teal_data and from tdata to teal_data @vedhav
@gogonzo gogonzo added the core label Oct 5, 2023
@gogonzo gogonzo changed the title Write new vignette about teal_data Write a new vignette about teal_data Oct 5, 2023
@chlebowa
Copy link
Contributor

chlebowa commented Oct 5, 2023

How about flag the old vignettes as archival and have a mention in the new one that other ways existed in the past?

@vedhav
Copy link
Contributor

vedhav commented Oct 5, 2023

I'm leaning towards not showing vignettes about the old stuff. As a user, I will be overwhelmed with a lot of deprecated stuff in the vignettes. Alternatively, it will be nice to place all the depreciated vignettes in just one navigation selection, my worry is that this will still make it available for search and easily mislead someone.

@m7pr
Copy link
Contributor

m7pr commented Oct 5, 2023

If we do support depracated functionality I would leave vignettes with a warning that they refer to the deprecated functionality. Once the functionality is removed I would opt for vignettes removal. The same way we keep manual pages for deprecated stuff.

@kartikeyakirar
Copy link
Contributor

kartikeyakirar commented Oct 5, 2023

Keeping old vignettes might be helpful if someone migrating from old to new , currently, we still support some of the old functionality, so it might be beneficial to retain the old vignettes with a disclaimer or warning.

@gogonzo
Copy link
Contributor Author

gogonzo commented Oct 5, 2023

Keeping old vignettes might be helpful if someone migrating from old to new

So we need extra vignette - "Migrate from TealData to teal_data"

@m7pr
Copy link
Contributor

m7pr commented Oct 6, 2023

So we need extra vignette - "Migrate from TealData to teal_data"

yeah, that would be the best!

@vedhav vedhav self-assigned this Oct 12, 2023
@vedhav vedhav linked a pull request Oct 23, 2023 that will close this issue
@gogonzo gogonzo self-assigned this Nov 27, 2023
gogonzo added a commit that referenced this issue Nov 29, 2023
closes #174 
- new vignette for teal_data and for reproducibility
@gogonzo gogonzo closed this as completed Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment