Consider standardizing the way functions are named #31
Labels
Comments
|
On second thought, maybe it is better if you deprecate and rename functions smoothly. rOpenSci has recommendations on this: |
19 tasks
gfinak
added a commit
that referenced
this issue
Jul 2, 2018
… based config. - #31 - update doc - remove test case for this function.
gfinak
added a commit
that referenced
this issue
Jul 2, 2018
according to guide: https://ropensci.github.io/dev_guide/evolution.html#functions-changing-function-names - update tests and docs - address #31
gfinak
added a commit
that referenced
this issue
Jul 2, 2018
- rename datapacakge.skeleton to datapackage_skeleton - add examples to datapackage_skeleton - add examples to package_build - add examples to data_version - add examples to datapackager_object_read keepDataObjects removed in 100f340 - fix renaming of functions so warnings only appear when old names are called - update docs - update tests
|
Solved. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Some exported functions are snake case
construct_yml_config()datapackager_object_readOthers are camel case
dataVersion()keepDataObjects()And one has a dot as the delimiter.
datapackage.skeleton()Please consider changing these names to a single convention. Snake case is usually recommended, but the important thing here is to be consistent. Another reason I recommend snake case is that most of your exported functions already use it. The usual practice is to smoothly deprecate old functions and point users to new ones,
but sinceDataPackageRis not on CRAN yet, I do not think it is a big deal if you just rename the affected functions.The text was updated successfully, but these errors were encountered: