Apply new formatter version #1842

JoshuaLampert · 2024-02-10T17:04:48Z

Due to domluna/JuliaFormatter.jl#792, which is part of the new version v1.0.46 from JuliaFormatter.jl released 13 hours ago, the formatting changes and CI fails. This PR applies the changes from the new version.

github-actions · 2024-02-10T17:05:07Z

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

The PR has a single goal that is clear from the PR title and/or description.
All code changes represent a single set of modifications that logically belong together.
No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

The code can be understood easily.
Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
There are no redundancies that can be removed by simple modularization/refactoring.
There are no leftover debug statements or commented code sections.
The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

New functions and types are documented with a docstring or top-level comment.
Relevant publications are referenced in docstrings (see example for formatting).
Inline comments are used to document longer or unusual code sections.
Comments describe intent ("why?") and not just functionality ("what?").
If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

The PR passes all tests.
New or modified lines of code are covered by tests.
New or modified tests run in less then 10 seconds.

Performance

There are no type instabilities or memory allocations in performance-critical parts.
If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

The correctness of the code was verified using appropriate tests.
If new equations/methods are added, a convergence test has been run and the results
are posted in the PR.

Created with ❤️ by the Trixi.jl community.

JoshuaLampert · 2024-02-10T17:12:00Z

src/meshes/t8code_mesh.jl

-                                ]
+                                mpi_mesh_info.mpi_mortars.local_neighbor_ids[local_mpi_mortar_id] = [current_index +
+                                                                                                     1]
+                                mpi_mesh_info.mpi_mortars.local_neighbor_positions[local_mpi_mortar_id] = [map_iface_to_ichild_to_position[iface + 1][t8_element_child_id(eclass_scheme, element) + 1]]


This line gets really long.

Did you check if a line break behind e.g. the = gets removed from the formater?

Yes, after the =, it does get removed. I've pushed an alternative in f393d48 with a line break after the first closing bracket.

Oh, never mind. This does not work.

So none of the tried options work?

Unfortunately yes. We could, however, give shorter names to map_iface_to_ichild_to_position[iface + 1] and t8_element_child_id(eclass_scheme, element) + 1 before.

Hm, I would hesitate to change variable names due to formatter issues - probably we have a new formatting in 2-3 months anyway

Maybe we should just push this through to get the other PRs going

codecov · 2024-02-10T17:42:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fe6a527) 96.38% compared to head (228fd01) 96.38%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1842   +/-   ##
=======================================
  Coverage   96.38%   96.38%           
=======================================
  Files         455      455           
  Lines       36391    36391           
=======================================
  Hits        35074    35074           
  Misses       1317     1317

Flag	Coverage Δ
unittests	`96.38% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

DanielDoehring

I like the more compact code

JoshuaLampert · 2024-02-12T10:06:24Z

CI failures seem to be a server error on the codecov side.

JoshuaLampert · 2024-02-12T12:39:58Z

Could maybe one of you have a brief look, @sloede, @ranocha? Thanks!

efaulhaber · 2024-02-12T15:25:20Z

src/meshes/t8code_mesh.jl

    map_iface_to_ichild_to_position = [
-        # 0  1  2  3  4  5  6  7 ichild/iface
-        [1, 0, 2, 0, 3, 0, 4, 0], # 0
-        [0, 1, 0, 2, 0, 3, 0, 4], # 1
-        [1, 2, 0, 0, 3, 4, 0, 0], # 2
-        [0, 0, 1, 2, 0, 0, 3, 4], # 3
-        [1, 2, 3, 4, 0, 0, 0, 0], # 4
-        [0, 0, 0, 0, 1, 2, 3, 4], # 5
-    ]
+                                       # 0  1  2  3  4  5  6  7 ichild/iface
+                                       [1, 0, 2, 0, 3, 0, 4, 0], # 0
+                                       [0, 1, 0, 2, 0, 3, 0, 4], # 1
+                                       [1, 2, 0, 0, 3, 4, 0, 0], # 2
+                                       [0, 0, 1, 2, 0, 0, 3, 4], # 3
+                                       [1, 2, 3, 4, 0, 0, 0, 0], # 4
+                                       [0, 0, 0, 0, 1, 2, 3, 4]]


This is absolutely terrible. Why do these things always happen in new versions of JuliaFormatter?

See domluna/JuliaFormatter.jl#806

efaulhaber · 2024-02-12T17:10:44Z

I created a PR reverting the changes in JuliaFormatter: domluna/JuliaFormatter.jl#807
I ran JuliaFormatter on Trixi.jl main with this patch, and there are no changes.
If my PR in JuliaFormatter is merged soon, we can avoid meging this huge PR and another subsequent PR reverting this PR again.

DanielDoehring · 2024-02-12T18:11:37Z

Question is whether we should pin the version of the Julia formatter to something fixed we are happy with? Otherwise stuff like this will come up again and probably confuse / de-motivate people in contributing.

Arpit-Babbar · 2024-02-13T07:44:10Z

Question is whether we should pin the version of the Julia formatter to something fixed we are happy with?

Some are indeed taking this approach SciML/ModelingToolkit.jl#2456

ranocha

I created a PR reverting the changes in JuliaFormatter: domluna/JuliaFormatter.jl#807 I ran JuliaFormatter on Trixi.jl main with this patch, and there are no changes. If my PR in JuliaFormatter is merged soon, we can avoid meging this huge PR and another subsequent PR reverting this PR again.

Thanks a lot, @efaulhaber! I would like to fix the version of JuliaFormatter (e.g., #1843) or wait for your patch to be accepted and released.

efaulhaber · 2024-02-13T13:14:31Z

Maybe it would make sense to permanently fix the formatter version, so that development is not delayed by new versions. But then add a GitHub workflow to periodically check if a new version is available and perhaps automatically create a PR like the compat workflow.

ranocha · 2024-02-13T18:21:15Z

That sounds like a good idea 👍

JoshuaLampert · 2024-02-13T19:22:32Z

Ok, then let's fix the JuliaFormatter version. Closing this.

apply new formatter version

228fd01

JoshuaLampert mentioned this pull request Feb 10, 2024

Add AnalysisSurfaceIntegral #1812

Merged

JoshuaLampert commented Feb 10, 2024

View reviewed changes

This was referenced Feb 10, 2024

Fix formatter version DLR-AMR/T8code.jl#58

Merged

Fix formatter version JoshuaLampert/DispersiveShallowWater.jl#89

Merged

DanielDoehring previously approved these changes Feb 10, 2024

View reviewed changes

linebreak

f393d48

JoshuaLampert dismissed DanielDoehring’s stale review via f393d48 February 12, 2024 08:55

revert linebreak

7b904d6

efaulhaber reviewed Feb 12, 2024

View reviewed changes

JoshuaLampert marked this pull request as draft February 12, 2024 17:18

ranocha mentioned this pull request Feb 13, 2024

Fix formatter to older version #1843

Merged

ranocha requested changes Feb 13, 2024

View reviewed changes

ranocha mentioned this pull request Feb 13, 2024

Fix formatter to old version SciML/RootedTrees.jl#163

Merged

JoshuaLampert closed this Feb 13, 2024

JoshuaLampert deleted the new-formatter-version branch February 18, 2024 18:55

efaulhaber mentioned this pull request Sep 10, 2024

Update JuliaFormatter to the latest version #2071

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apply new formatter version #1842

Apply new formatter version #1842

JoshuaLampert commented Feb 10, 2024

github-actions bot commented Feb 10, 2024

JoshuaLampert Feb 10, 2024 •

edited

Loading

DanielDoehring Feb 12, 2024

JoshuaLampert Feb 12, 2024

JoshuaLampert Feb 12, 2024

DanielDoehring Feb 12, 2024

JoshuaLampert Feb 12, 2024

DanielDoehring Feb 12, 2024

DanielDoehring Feb 12, 2024 •

edited

Loading

codecov bot commented Feb 10, 2024 •

edited

Loading

DanielDoehring left a comment

JoshuaLampert commented Feb 12, 2024

JoshuaLampert commented Feb 12, 2024

efaulhaber Feb 12, 2024 •

edited

Loading

efaulhaber Feb 12, 2024

efaulhaber commented Feb 12, 2024

DanielDoehring commented Feb 12, 2024

Arpit-Babbar commented Feb 13, 2024

ranocha left a comment

efaulhaber commented Feb 13, 2024

ranocha commented Feb 13, 2024

JoshuaLampert commented Feb 13, 2024

Apply new formatter version #1842

Apply new formatter version #1842

Conversation

JoshuaLampert commented Feb 10, 2024

github-actions bot commented Feb 10, 2024

Review checklist

Purpose and scope

Code quality

Documentation

Testing

Performance

Verification

JoshuaLampert Feb 10, 2024 • edited Loading

Choose a reason for hiding this comment

DanielDoehring Feb 12, 2024

Choose a reason for hiding this comment

JoshuaLampert Feb 12, 2024

Choose a reason for hiding this comment

JoshuaLampert Feb 12, 2024

Choose a reason for hiding this comment

DanielDoehring Feb 12, 2024

Choose a reason for hiding this comment

JoshuaLampert Feb 12, 2024

Choose a reason for hiding this comment

DanielDoehring Feb 12, 2024

Choose a reason for hiding this comment

DanielDoehring Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Feb 10, 2024 • edited Loading

Codecov Report

DanielDoehring left a comment

Choose a reason for hiding this comment

JoshuaLampert commented Feb 12, 2024

JoshuaLampert commented Feb 12, 2024

efaulhaber Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

efaulhaber Feb 12, 2024

Choose a reason for hiding this comment

efaulhaber commented Feb 12, 2024

DanielDoehring commented Feb 12, 2024

Arpit-Babbar commented Feb 13, 2024

ranocha left a comment

Choose a reason for hiding this comment

efaulhaber commented Feb 13, 2024

ranocha commented Feb 13, 2024

JoshuaLampert commented Feb 13, 2024

JoshuaLampert Feb 10, 2024 •

edited

Loading

DanielDoehring Feb 12, 2024 •

edited

Loading

codecov bot commented Feb 10, 2024 •

edited

Loading

efaulhaber Feb 12, 2024 •

edited

Loading