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

Apply runic formatting #41

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

Apply runic formatting #41

wants to merge 1 commit into from

Conversation

jpthiele
Copy link
Contributor

@jpthiele jpthiele commented Jan 6, 2025

No description provided.

@@ -26,45 +26,45 @@ function main(;Plotter = PyPlot, plotting = false, verbose = false, test = false
################################################################################

## region numbers
regionAcceptor = 1 # p doped region
Copy link
Member

@pjaap pjaap Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be a worsening of the formatting here and at all other similar occurrences. If you wish to keep the aligned values, add the runic: on/off around these lines. See https://github.com/fredrikekre/Runic.jl#toggle-formatting

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WIAS-PDELib/numsemic I'd be happy to undo this part of the formatting if you want,
but it's up to your preference.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, thanks @jpthiele, would be happy if you do not mind to undo it, thanks :)

Copy link
Member

@pjaap pjaap Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The chosen code formatter of this orga, Runic.jl, does not allow code to be aligned with spaces. Therefore, we have to explicitly disable it at each desired place, so it is not just undoing the formatting.

Explicit # runic: off and # runic: on comments need to be added at every block of explicitly aligned code. By flying over the diff of this PR, I see a lot occurrences of aligned values that would be removed by Runic.jl.

I am in favor of as much default formatted code as possible. So it may be better for the developers of the code to mark the occurrences where the alignment by spaces is really important.

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.

3 participants