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

Adds Styler to the project #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adds Styler to the project #26

wants to merge 1 commit into from

Conversation

adkron
Copy link
Collaborator

@adkron adkron commented May 27, 2023

Styler fixes some of the credo checks that can be automated, so we don't have to think about it. It also rearranges the file into a standard order. This helps because while we are working, we can stay at the same level as the code we are writing and add our imports and everything there. Then when we format, it will move those to the correct locations so we never have to think about it again.

There is one side effect. Since some of our module-attributes depended on other module-attributes, i.e., documentation, we need to move those to bare identifiers outside the module. These identifiers only exist during the compilation process.

I believe this may help keep things consistent even with outside contributors and without putting as much onus on them.

Styler fixes some of the credo checks that can be automated, so we don't
have to think about it. It also rearranges the file into a standard
order. This helps because while we are working, we can stay at the
same level as the code we are writing and add our imports and everything
there. Then when we format, it will move those to the correct locations
so we never have to think about it again.

There is one side effect. Since some of our module-attributes depended
on other module-attributes, i.e., documentation, we need to move those to
bare identifiers outside the module. These identifiers only exist
during the compilation process.

I believe this may help keep things consistent even with outside
contributors and without putting as much onus on them.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant