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

Remove trailing semicolons in elixirs #2158

Closed

Conversation

JoshuaLampert
Copy link
Member

@JoshuaLampert JoshuaLampert commented Nov 13, 2024

As discussed with @DanielDoehring in #2156 (comment). Turns out 80 out of 424 elixirs had this semicolon.

I used the following script for that
for (root, _, files) in walkdir("examples")
    for file in files
        if endswith(file, ".jl")
            path = joinpath(root, file)
            lines = readlines(path)
            open(path, "w") do io
                for line in lines
                    if startswith(line, "ode =") && endswith(line, ";")
                        println(io, line[1:(end - 1)])
                    else
                        println(io, line)
                    end
                end
            end
        end
    end
end

Copy link
Contributor

@DanielDoehring DanielDoehring left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Contributor

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 with its PR number.

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.

@DanielDoehring DanielDoehring added low-priority refactoring Refactoring code without functional changes labels Nov 13, 2024
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks. There seems to be something wrong with Codecov. Let's check again later.

@JoshuaLampert
Copy link
Member Author

Codecov issues persist. Maybe this is related to tokenless upload because I created the PR from my fork. Maybe related to #1905. I created a new PR #2161 to try. Closing this in favor of #2161.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low-priority refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants