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

Deprecate the file_size() function #129

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Conversation

Moohan
Copy link
Member

@Moohan Moohan commented Jul 1, 2024

This resolves #11

As far as we can tell file_size() is now redundant.

This PR deprecates the function and removes it from the package documentation, if no one objects we can remove it in a future version. For now file_size() will still work but will generate a warning every time, ?file_size will also bring up the function help but the help won't appear in the function reference.

@Moohan Moohan requested a review from Tina815 July 1, 2024 14:47
@Moohan Moohan changed the title Deprecate the file_size() function. Deprecate the file_size() function Jul 1, 2024
@Moohan Moohan force-pushed the deprecate_file_size branch from 5657594 to 867bba3 Compare August 26, 2024 17:34
Moohan and others added 7 commits October 21, 2024 11:21

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon
I also followed the advice to remove the deprecated tag `@docType package` and instead document the special object `"_PAKCAGE"`. I used `usethis::use_package_doc()` for this and then moved the `@importFrom`s.

The change for users here is that the top-level documentation available to users in R should be easier to get to (more aliases) and will have better content (since it will now auto-populate from the DESCRIPTION file.

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon

Verified

This commit was signed with the committer’s verified signature.
Moohan James McMahon
@Moohan Moohan force-pushed the deprecate_file_size branch from ecabb8b to d5e2854 Compare October 21, 2024 10:22
@Moohan Moohan requested a review from Nic-Chr October 21, 2024 10:23
Moohan and others added 6 commits November 18, 2024 14:42

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@Moohan
Copy link
Member Author

Moohan commented Nov 18, 2024

@Tina815 all checks passing (properly) now 👍

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.

file_size was designed for old template
2 participants