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

Select a supported Python documentation format and a linter. #7

Open
jeff-cohere opened this issue Aug 13, 2024 · 0 comments
Open

Select a supported Python documentation format and a linter. #7

jeff-cohere opened this issue Aug 13, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation style

Comments

@jeff-cohere
Copy link
Collaborator

jeff-cohere commented Aug 13, 2024

Per @ialarmedalien 's recommendations in reviewing #1 .

FWIW I use the google documentation style, and ruff for python code linting/formatting. I use VSCode for working with python -- there's an extension for generating python documentation for functions and a nice ruff integration, so you can handle all that stuff whilst you're working on the code. I'm sure that there are also emacs / vi / etc. integrations for ruff, too.

@jeff-cohere jeff-cohere added documentation Improvements or additions to documentation style labels Aug 13, 2024
@jeff-cohere jeff-cohere self-assigned this Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation style
Projects
None yet
Development

No branches or pull requests

1 participant