Rename dimensions to dims in docs

[brynpickering]

Fixes #612

Reviewer checklist

• [ ] Test(s) added to cover contribution
• [ ] Documentation updated
• [x] Changelog updated
• [ ] Coverage maintained or improved

[brynpickering]

This is something @sjpfenninger and I went back and forth on a lot. Would you prefer dimensions and add_dimensions everywhere, or dims and add_dims @irm-codebase @FLomb ?

[FLomb]

This is something @sjpfenninger and I went back and forth on a lot. Would you prefer dimensions and add_dimensions everywhere, or dims and add_dims @irm-codebase @FLomb ?

I don't have a strong preference for either of the two, but I agree it'd be nice to have consistency across all functions for which the "dimension" concept is part of the name.

[irm-codebase]

@brynpickering : I agree with Francesco.

dims is shorter, and probably more enjoyable for users. I think it's fine to keep it and change add_dims, but we need to make sure that all the user-side code / YAML stuff sticks to that convention. Basically:

User-side:

• If it is a variable or parameter, use dims.
• If it's documentation talking about it, either dims or dimensions is fine (we do this for techs / technology, with little complaints). Internally (code variables and docstrings):
• Use either. Not really enforceable, and kind of a waste of time to pursue full consistency imo. If the code is clear it is a non issue.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.07%. Comparing base (872978d) to head (41966a8). Report is 15 commits behind head on main.

:exclamation: Current head 41966a8 differs from pull request most recent head 2b649cc

Please upload reports for the commit 2b649cc to get more accurate results.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #621 +/- ## ========================================== + Coverage 95.85% 96.07% +0.22% ========================================== Files 24 24 Lines 3619 3646 +27 Branches 788 733 -55 ========================================== + Hits 3469 3503 +34 + Misses 86 81 -5 + Partials 64 62 -2 ``` | [Files](https://app.codecov.io/gh/calliope-project/calliope/pull/621?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project) | Coverage Δ | | |---|---|---| | [src/calliope/preprocess/data\_sources.py](https://app.codecov.io/gh/calliope-project/calliope/pull/621?src=pr&el=tree&filepath=src%2Fcalliope%2Fpreprocess%2Fdata_sources.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL3ByZXByb2Nlc3MvZGF0YV9zb3VyY2VzLnB5) | `100.00% <100.00%> (ø)` | | ... and [14 files with indirect coverage changes](https://app.codecov.io/gh/calliope-project/calliope/pull/621/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project)