beRi icon indicating copy to clipboard operation
beRi copied to clipboard

Decide on code formatter and code style for beRi and subprojects

Open sdhutchins opened this issue 6 years ago • 2 comments

There are a number of docstring styles and overall code style formatters that can be implemented to make code style easier to manage and implement across for multiple maintainers and projects.

  • [ ] Choose a formatter.

Check out Auto formatters for Python to see a review of yapf, black, and autopep8.


  • [ ] Choose a docstring style.

Check out Docstrings by Example: Documenting Python Code the Right Way for different docstring examples.

pyment can also be used to autogenerate docstrings.

sdhutchins avatar Oct 08 '18 21:10 sdhutchins

See https://github.com/datasnakes/renv/issues/17

sdhutchins avatar Oct 08 '18 22:10 sdhutchins

As discussed earlier today, 1. default to google code style, 2. Use pycharm (mainly 4 spaces instead of a tab for indentation.).

sdhutchins avatar Oct 13 '18 01:10 sdhutchins