796 always return #953
796 always return #953
Conversation
|
I'm not sure all the files should be changed with adding 'return.' |
| @@ -441,8 +442,7 @@ See the file <benchmark/profiling.jl> for an example of profiling code. | |||
| When publishing a new version of the model to the Julia Registry, follow this procedure: | |||
|
|
|||
| > **Note:** | |||
| > To be able to register, you need to be a member of the organisation TulipaEnergy and have your visibility set to public:<br> | |||
| >  | |||
| > To be able to register, you need to be a member of the organisation TulipaEnergy and have your visibility set to public:<br> >  | |||
There was a problem hiding this comment.
Not sure why this changed.
| @@ -19,7 +19,7 @@ function add_consumer_constraints!(model, constraints, graph, sets) | |||
|
|
|||
| # - Balance constraint (using the lowest temporal resolution) | |||
| df = filter(:asset => ∈(Ac), constraints[:highest_in_out].indices; view = true) | |||
| model[:consumer_balance] = [ | |||
| return model[:consumer_balance] = [ | |||
There was a problem hiding this comment.
I wonder if this is correct or these should all be return nothing.
There was a problem hiding this comment.
The JuliaFormatter is technically correct, because these were indeed being returned implicitly. But we don't expect any return, so adding an empty return after this is better, in my opinion
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #953 +/- ##
=======================================
Coverage 95.50% 95.50%
=======================================
Files 30 30
Lines 1045 1045
=======================================
Hits 998 998
Misses 47 47 ☔ View full report in Codecov by Sentry. |
| @@ -198,6 +198,7 @@ We will try to follow these during development and reviews. | |||
| - List obvious objects, e.g., `using JuMP: @variable`, since `@variable` is obviously from JuMP in this context, or `using Graph: SimpleDiGraph`, because it's a constructor with an obvious name. | |||
| - For other objects inside `Package`, use `using Package: Package` and explicitly call `Package.A` to use it, e.g., `DataFrames.groupby`. | |||
| - List all `using` in <src/TulipaEnergyModel.jl>. | |||
| - Explicitly state what a function will `return`, including `return nothing`. | |||
There was a problem hiding this comment.
| - Explicitly state what a function will `return`, including `return nothing`. | |
| - Explicitly state what a function will `return`, including `return nothing`. |
|
Indeed, many places will be changed with this new rule because all functions return something (implicit rule is to return the last thing in a function). This is annoying, but necessary with this change. For most places, we are going to need manual intervention to add and empty |
Related issues
Closes #796
Closes #940
Checklist
I am following the contributing guidelines
Tests are passing
Lint workflow is passing
Docs were updated and workflow is passing