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

Code formatting #56

Merged
merged 3 commits into from
Jun 10, 2024
Merged

Code formatting #56

merged 3 commits into from
Jun 10, 2024

Conversation

graeme-a-stewart
Copy link
Member

Use code formatting with the setup:

style = "sciml"
yas_style_nesting = true

Source files are reformatted and a GitHub action is added

@Moelf
Copy link
Member

Moelf commented Jun 7, 2024

This is the expected behavior of the format CI right?

@graeme-a-stewart
Copy link
Member Author

This is the expected behavior of the format CI right?

Yes, when there is a file that's badly formatted - though the error message isn't super helpful, right?

Anyway, fixed the last file and let's retry...

@graeme-a-stewart
Copy link
Member Author

Thanks for the approve @Moelf!

This is definitely worth having, but the action could really be improved by saying which files needed reformatted. format(...) only returns a bool, so one has to do a manual check as to which files needed to be fixed. At least we need to document it - gosh! we need a contributors' guide it seems.

@graeme-a-stewart graeme-a-stewart merged commit 8b5f582 into main Jun 10, 2024
5 checks passed
@graeme-a-stewart graeme-a-stewart deleted the code-formatting branch June 10, 2024 09:09
@Moelf
Copy link
Member

Moelf commented Jun 10, 2024

I thought https://github.com/julia-actions/julia-format would give you inline comment or something

@graeme-a-stewart
Copy link
Member Author

It seems the workflow suggestion is to pipe this into https://github.com/reviewdog/reviewdog, which will then make a suggestion on the PR

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.

2 participants