Add explicit return to JuliaFormatter and docs

[clizbe]

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

[clizbe]

I'm not sure all the files should be changed with adding 'return.'
I ran JuliaFormatter using format(".") which might touch files we don't normally format.

[codecov]

Codecov Report

Attention: Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 94.99%. Comparing base (2273603) to head (345ad10).

Files with missing lines	Patch %	Lines
src/io.jl	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #953      +/-   ##
==========================================
+ Coverage   94.94%   94.99%   +0.05%     
==========================================
  Files          29       29              
  Lines        1068     1079      +11     
==========================================
+ Hits         1014     1025      +11     
  Misses         54       54              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[abelsiqueira]

Suggested change

	- Explicitly state what a function will `return`, including `return nothing`.
	- Explicitly state what a function will `return`, including `return nothing`.

[abelsiqueira]

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 return before the end to reflect the desired behaviour (assuming the desired behaviour is to return nothing for functions that are not expected to return anything)

[clizbe]

@abelsiqueira I fixed a lot of them, but the rest I'm not sure if it was an implicit return or returning nothing.
Also I changed the docs to just return instead of return nothing since it looks like that's what we were using (and in my opinion it looks better).

[clizbe]

Dangit I dunno why the conflict merger never works for me. I must be skipping a step. -_-

[abelsiqueira]

Thanks for the update. I marked a few places, which are the most relevant. The files in utils/scripts don't matter, because they won't be run again, so I haven't reviewed whether it should be an empty return or not.

When it's ready to be merged, please mark as ready to review, I'll approve, and we can try to merge at a moment that avoids conflicts (since it's changing a bunch of files)

[clizbe]

Thanks! Yeah sorry for jumping in and creating conflicts.
Just got bored and missed coding!

[abelsiqueira]

Thanks for the updates. @datejada and I will merge it now, but we'll rebase your branch ourselves