Rename functions#282
Merged
Merged
Conversation
get_resource() does not need to be deprecated as it is not a public function
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #282 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 23 +1
Lines 638 650 +12
=========================================
+ Hits 638 650 +12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
Author
|
Right, I forgot tests for my deprecated functions. Will add that. |
damianooldoni
approved these changes
Oct 7, 2025
damianooldoni
left a comment
Contributor
There was a problem hiding this comment.
Good work. Everything done as it should by using lifecycle R package both in functions and in tests. 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix #263
Our functions all start with a verb, which makes sense, because they perform an action (read, create, remove).
That is less the case for accessor functions (which have a generic "get"). That is why it's more intuitive to just call them after the thing, e.g.
schema()rather thanget_schema(). We already did this withresources(), which is better namedresource_names()as that is what it returns. Future accessor functions could includeversion().This PR therefore renames:
get_schema()→schema(): a public accessor function => deprecationresources()→resource_names(): a publicreadaccessor function => deprecationget_resource()→resource(): a private accessor function => no deprecationThe filename for
print.Ris also renamed toprint.datapackage.Rin preparation for print functions forschema()andresource().