Update code as per Julia's community guidelines

[eulerkochy]

Multiline functions should use return for returning values.
PR is trivial enough.
I'll go through each of the files and try to spot if some part of the code violates standard. Gonna take a while. Bare through that period.

List of checked files.

• src/heaps
• robin_dict.jl

[codecov]

Codecov Report

Merging #590 into master will increase coverage by 0.01%.
The diff coverage is 98.4%.

@@            Coverage Diff             @@
##           master     #590      +/-   ##
==========================================
+ Coverage   95.01%   95.03%   +0.01%     
==========================================
  Files          33       33              
  Lines        2831     2820      -11     
==========================================
- Hits         2690     2680      -10     
+ Misses        141      140       -1

Impacted Files	Coverage Δ
src/heaps/binary_heap.jl	100% <100%> (ø)	⬆️
src/heaps.jl	100% <100%> (ø)	⬆️
src/mutable_list.jl	99.32% <100%> (+0.65%)	⬆️
src/priorityqueue.jl	98.67% <100%> (ø)	⬆️
src/disjoint_set.jl	98.57% <100%> (ø)	⬆️
src/queue.jl	100% <100%> (ø)	⬆️
src/deque.jl	98.59% <100%> (ø)	⬆️
src/accumulator.jl	93.75% <100%> (ø)	⬆️
src/sorted_multi_dict.jl	92.92% <100%> (ø)	⬆️
src/heaps/minmax_heap.jl	100% <100%> (ø)	⬆️
... and 14 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d321175...3e26db8. Read the comment docs.

[oxinabox]

Looks great.
Is it ready to merge, or do you want to finish going through othter files?

[eulerkochy]

I'll plan to go through all the files and bump this PR. I have some commits on local machine, I'll push them as soon as I can.

…

On Wed 11 Mar, 2020, 5:35 PM Lyndon White, ***@***.***> wrote: Looks great. Is it ready to merge, or do you want to finish going through othter files? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#590?email_source=notifications&email_token=AIC2RRIP6UWUSPW6WFFHUNDRG547FA5CNFSM4LDOAW62YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOPI6MQ#issuecomment-597593906>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIC2RRKKADX557MF75AFPG3RG547FANCNFSM4LDOAW6Q> .

[eulerkochy]

@oxinabox I guess this PR is now ready! Have a look at it.

Now, since I read and understood through the entirity of the codebase(only the src, not the tests and benchmarks), here are few of my observations:

• code can be made more terse in some places. If it wasn't begging to be done, I haven't changed it in this PR, because I guess it was outside its scope.
• two files, int_set.jl and trie.jl are poorly documented in terms of docstrings.
• I absolutely loved the documentation of sorted_dict.jl and sorted_multi_dict.jl. What's so special about it? The docstrings are written in a nice way and most importantly, explicitly mention asymptotic complexity of the operations, something which is missing in the entire codebase. As a data structures repo, I feel this is quintessential and got to be present. Opinion?

[oxinabox]

I absolutely loved the documentation of sorted_dict.jl and sorted_multi_dict.jl. What's so special about it?

Different parts of this package have come from different places at different times.
For example the priority queue and minheap stuff was written by Jeff back in Julia 0.1 days, and used to be part of the language itself.

The Sorted* types were written by @StephenVavasis

[oxinabox]

Just a few minor things.
Fix them and then it is good to merge.

---

I have invited you as a collaborator to the repository (via making you a member of the org).
you'll need to accept your invite and (if you haven't already) setup 2FA.
Few things:

• Don't merge your own PRs without review. (Exception if just bumping version number to tag release.)
• Follow the Continuous Delivery pattern and tag a release after every PR that has a functional change. Unless the project.toml version is suffixed with -DEV. Try and avoid making breaking releases. (thats what setting -DEV is for, bundling a collection of breaking changes)