Add warning for aliases athat aren't used

[tjburch]

Resolves #675 by throwing a warning if any aliases are not used. I didn't want to make the warnings too verbose, so if there's 5 or fewer aliases that aren't used, it explicitly tells you which aren't used. If more than 5 aren't used, it throws a generic message.

[canyon289]

Add a comment to this one and the code block below so when reading this module its more clear how the list, and the if missing_name block below interact

[tjburch]

done

[canyon289]

Thanks! Tomas can comment on the rest of the logic. LGTM but he knows best!

[tomicapretto]

If I understand correctly this is "asking" the same questions that were in the for loop again. If they are all False, it means none of the if-blocks in the previous if-statements got executed, implying the alias was not used.

What do you think about this alternative approach (pseudo-code)?

for name, alias in aliases.items():
    is_used = False
    
    if cond1:
        ....
        is_used = True

    if cond2:
        ...
        is_used = True


     # finally
     if not is_used:
          missing_names.append(name)

I know it introduces a new auxiliary variable. But I think it's slightly clearer since the human-reader doesn't need to parse a "complex" if statement with multiple conditions.

[tjburch]

Definitely cleaner. Added.

[codecov-commenter]

Codecov Report

Merging #691 (03c74ff) into main (259c474) will increase coverage by 0.00%.
The diff coverage is 88.88%.

@@           Coverage Diff           @@
##             main     #691   +/-   ##
=======================================
  Coverage   88.32%   88.33%           
=======================================
  Files          40       40           
  Lines        2862     2880   +18     
=======================================
+ Hits         2528     2544   +16     
- Misses        334      336    +2     

Impacted Files	Coverage Δ
bambi/models.py	79.16% <88.88%> (+0.51%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[tomicapretto]

Thanks a lot again @tjburch for the useful contribution. And thanks @canyon289 for the review!

I think the logic is good. Still, I left a comment suggesting an approach that may be a little bit better. Let me know what you think.

The only thing I would add to the PR is a test that checks the warning is raised. It can go into tests/test_aliases.py

[tjburch]

Thanks for the reviews. Made the specified changes, and just added the tests too.