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

style: Add Black formatting exceptions for equations #30

Closed
5 tasks done
uwcdc opened this issue Dec 1, 2023 · 1 comment · Fixed by #64
Closed
5 tasks done

style: Add Black formatting exceptions for equations #30

uwcdc opened this issue Dec 1, 2023 · 1 comment · Fixed by #64
Assignees

Comments

@uwcdc
Copy link
Member

uwcdc commented Dec 1, 2023

In the source code, there are lengthy equations that, when formatted by Black, may result in less readable or undesired formatting. To address this, we propose introducing #fmt: off and #fmt: on tags to instruct Black to skip formatting for specific lines containing equations.

  • Identify the specific lines in the source code that contain equations requiring special formatting consideration
  • Introduce #fmt: off (before the lines) and #fmt: on (after the lines) with equations to instruct Black to skip formatting for those lines
  • Verify that lines with #fmt: off and #fmt: on tags are excluded from Black formatting
  • Ensure that the introduction of formatting exceptions does not compromise the overall readability and consistency of the code
  • Update the project documentation to include information about the use of #fmt: off and #fmt: on tags for Black formatting exceptions
@uwcdc uwcdc added the 5d 5 Days estimate of work label Dec 1, 2023
@uwcdc uwcdc self-assigned this Dec 1, 2023
@lsetiawan lsetiawan removed the 5d 5 Days estimate of work label Dec 6, 2023
@uwcdc uwcdc changed the title Add Black formatting exceptions for equations style: Add Black formatting exceptions for equations Dec 7, 2023
@lsetiawan
Copy link
Member

This will be addressed in Ciela-Institute#122

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