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

unexport and undocument DT(), closes #5472 #5730

Merged
merged 5 commits into from
Dec 8, 2023
Merged

unexport and undocument DT(), closes #5472 #5730

merged 5 commits into from
Dec 8, 2023

Conversation

jangorecki
Copy link
Member

closes #5472

Based on two PRs
#5104
#5113
functionality is still there, it is just not exported and documented.

I encourage users interested in this functionality to use

DT = data.table:::DT

and play with it. Just be aware that there are couple open issue that affects DT() as of now, all listed in DT()

@jangorecki jangorecki added this to the 1.15.0 milestone Nov 6, 2023
Copy link

codecov bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3ad0e8e) 97.46% compared to head (1c9e6ab) 97.46%.

❗ Current head 1c9e6ab differs from pull request most recent head 8f96736. Consider uploading reports for the commit 8f96736 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5730      +/-   ##
==========================================
- Coverage   97.46%   97.46%   -0.01%     
==========================================
  Files          80       80              
  Lines       14820    14814       -6     
==========================================
- Hits        14445    14439       -6     
  Misses        375      375              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jangorecki
Copy link
Member Author

inviting @eddelbuettel to review, as you mentioned that you use DT() function (in #5808)

Copy link
Contributor

@eddelbuettel eddelbuettel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how much I can say here so I just leave a comment -- I got used to the exported version that I use(d) in some workflows / experiments here. I like its compactness, and forcing data.table::DT is much less attractive, as is having to make a local copy.

@MichaelChirico
Copy link
Member

I got used to the exported version

IINM the intention is to un-export it to remove it as a block to releasing 1.15.0, then export it again after fixing the pending issues. We might also export it in 1.15.99 dev version after a CRAN release.

@jangorecki
Copy link
Member Author

Yes, the issue explains:

Therefore to not slow down 1.14.4 1.15.0 I suggest to mark DT() as not exported for the current moment, and re-export it shortly after release (if there will be such demand, see #5621);

@@ -8,6 +8,7 @@ if (exists("test.data.table", .GlobalEnv, inherits=FALSE)) {
if ((tt<-compiler::enableJIT(-1))>0)
cat("This is dev mode and JIT is enabled (level ", tt, ") so there will be a brief pause around the first test.\n", sep="")
rm_all = function() {}
DTfun = DT ## otherwise DT would be re-defined by many tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a good point... exporting DT() will open up many accidental "object of type closure is not subsettable" issues when user makes an ad hoc object named DT but runs DT[...] in a context where it's only defined as data.table::DT(). somewhat unfortunate that DT and dt are both taken as placeholder object names in exploratory work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree

@jangorecki jangorecki requested a review from mattdowle as a code owner December 8, 2023 16:01
@jangorecki jangorecki merged commit 6bde008 into master Dec 8, 2023
2 of 3 checks passed
@jangorecki jangorecki deleted the undt branch December 8, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Do not export DT() yet
4 participants