Skip to content

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

@jeff-cohere

Description

@jeff-cohere

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationstyle

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions