search

nx10 / httpgd

Asynchronous http server graphics device for R.
https://nx10.github.io/httpgd
GNU General Public License v2.0
377 stars 19 forks source link

Use snake case for function names #44

Closed nx10 closed 3 years ago

nx10 commented 3 years ago

The Tidyverse style guide recommends snake case for function names. I propose these function name changes:

old new
httpgd hgd
httpgdBrowse hgd_browse
httpgdClear hgd_clear
httpgdCloseAllServers hgd_close(all = T)
httpgdCloseServer hgd_close
httpgdGenerateToken hgd_generate_token
httpgdRemove hgd_remove
httpgdSVG hgd_svg
httpgdState hgd_state
httpgdURL hgd_url

This breaking change should probably be done as soon as possible (before we release to CRAN).

As httpgd_ is pretty long we could also consider to use hgd_ instead as a shorter prefix.

renkun-ken commented 3 years ago

Since this package is mostly used interactively, breaking changes should not impact as much as those used in any production systems. I agree that these breaking changes should be made as early as possible.

nx10 commented 3 years ago

The function names are now changed.