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

Comments should not be moved across parentheses #814

Open
LilithHafner opened this issue Feb 15, 2024 · 0 comments
Open

Comments should not be moved across parentheses #814

LilithHafner opened this issue Feb 15, 2024 · 0 comments

Comments

@LilithHafner
Copy link

Code like

combine(x, 3 #= this is the magic number =#) 

should probably not be reformatted to

combine(x, 3) #= this is the magic number =#

because the comment may refer to the function argument specifically.

In general, comments should typically not be moved as much because they are more likely to be intentionally placed with readability and formatting in mind.

Originally reported by @oscardssmith in SciML/DiffEqBase.jl#1008 (comment)

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

No branches or pull requests

1 participant