Codecov Report

Merging#1838 (b981ce7) intomain (cbbe7ce) willnot change coverage.
The diff coverage is100.00%.

@@           Coverage Diff           @@##             main    #1838   +/-   ##=======================================  Coverage   92.26%   92.26%           =======================================  Files          77       77             Lines        4849     4849           =======================================  Hits         4474     4474             Misses        375      375

Flags with carried forward coverage won't be shown.Click here to find out more.

I don't think it'sthat confusing as it's quite a common pattern (e.g.https://github.com/mtkennerly/poetry-dynamic-versioning/blob/4454e5082bf1fc2f4a39fa523a9b665eda5d638f/poetry_dynamic_versioning/__init__.py#L86-L89 among others).

version.py could also be confusing as we havehttps://docs.gitlab.com/ee/api/version.html, so maybe we could do_version.py then, to signify it's not anything to do with it?

I don't think it'sthat confusing as it's quite a common pattern (e.g.https://github.com/mtkennerly/poetry-dynamic-versioning/blob/4454e5082bf1fc2f4a39fa523a9b665eda5d638f/poetry_dynamic_versioning/__init__.py#L86-L89 among others).

I'm as big a fan of cargo-culting as the next person. But in our case due to the ordering of imports it is confusing. Because at some points in the code__version__ is the version string, but in other locations it is a module. Which I have found confusing when trying to work on the code as I need to understand where in the import cycle we are to know which value it is.

I did update the commit message to point out one actual situation of confusion.

version.py could also be confusing as we havehttps://docs.gitlab.com/ee/api/version.html, so maybe we could do_version.py then, to signify it's not anything to do with it?

Done!

Ahh ok, that makes sense. Thanks!