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

Check code style #187

Open
2 tasks
cncastillo opened this issue Oct 21, 2023 · 2 comments
Open
2 tasks

Check code style #187

cncastillo opened this issue Oct 21, 2023 · 2 comments
Assignees
Labels
1) high priority enhancement New feature or request

Comments

@cncastillo
Copy link
Member

cncastillo commented Oct 21, 2023

I believe most of the code is following the Julia blue code style (we need to read this carefully). A re-check of the code to verify that this is true is needed,

This code style is the one used in the Julia Formatter as well, that should work with VSCode to do automatic reformatting. We should do this to each file, some parts of the code are prettier with the current format, in those cases we can add a comment to skip the formatting. At least doing it this way it is explicit that a code block is not in the format.

There are some files that I am sure that are not in Julia blue (CamelCase variable names) like:

https://github.com/cncastillo/KomaMRI.jl/blob/master/KomaMRICore/src/io/Pulseq.jl

  • Variable names
  • Spaces to replace tabs
@beorostica
Copy link
Contributor

beorostica commented Oct 24, 2023

This is a related issue of another repo with comments to keep in mind.

@cncastillo
Copy link
Member Author

We should just add a Julia format GitHub Action, as discussed in:

#342 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1) high priority enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants