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

Decide on code formatter and code style for beRi and subprojects #17

Open
2 tasks
sdhutchins opened this issue Oct 8, 2018 · 2 comments
Open
2 tasks

Comments

@sdhutchins
Copy link
Member

sdhutchins commented Oct 8, 2018

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
Copy link
Member Author

See datasnakes/renv#17

@sdhutchins
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants