You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The code in legion/agents, legion/interface, and legion/blocks should adhere to PEP8 styling for visual consistency and code quality.
Proposed Solution
In scripts/lint.py, there is a script that uses flake8 to find code styling errors, and ruff to try to automatically fix them. This can be slightly reworked to find/auto-resolve/output remaining issues for specific directories.
Alternative Solutions
Additional Context
Implementation Ideas
Benefits
Improved developer experience, specifically those helping to maintain the codebase.
Potential Challenges
Code styling is kind of boring, but important.
The text was updated successfully, but these errors were encountered:
There are a bunch of style issues of the following type -
D401 First line of docstring should be in imperative mood: "Helper function to create annotated parameter types with descriptions"
Should these types of issues be ignored? There are a lot of docstrings in the the codebase that does not follow this and IMO, they look fine. Changing them manually one by one into imperative mood will be a lot of work with only few upsides. Does it make sense to add this to the ignored list of linting issues?
Also, the contributing.md file says the line length for code is meant to be 79 characters. However, the ruff setting is set to 100 for max code length. Could you confirm which one it is?
I'll be reducing the linting ruleset, as right now they seems a bit 'too picky' for no good reason. I just used some defaults I foud online. I'll DM you on Discord with updates.
Problem Statement
The code in
legion/agents
,legion/interface
, andlegion/blocks
should adhere to PEP8 styling for visual consistency and code quality.Proposed Solution
In
scripts/lint.py
, there is a script that usesflake8
to find code styling errors, andruff
to try to automatically fix them. This can be slightly reworked to find/auto-resolve/output remaining issues for specific directories.Alternative Solutions
Additional Context
Implementation Ideas
Benefits
Improved developer experience, specifically those helping to maintain the codebase.
Potential Challenges
Code styling is kind of boring, but important.
The text was updated successfully, but these errors were encountered: