You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We are doing most of our importing from dependencies with generic using statements (e.g., using Unitful) which makes it hard for people not familiar with the dependencies (e.g., me) to tell where some methods/definitions are coming from. By using explicit imports or qualified names (e.g., using Unitful: m, <etc...> or import Unitful as u; u.m we make this discovery process easier -- e.g., if I see an unqualified interpolate method being used in our code, I can go to the imports block and see where it is being imported from quickly.
Similarly I would move import statements out of included files like color_law.jl and dust_maps.jl and put all the imports in the same place at the module level in the DustExtinction.jl file. Having all the imports in one place simplifies the process of auditing the dependencies so you don't have to crawl through all the source files to find all the import statements.
I think this would improve maintainability / onboarding for new maintainers.
The text was updated successfully, but these errors were encountered:
We are doing most of our importing from dependencies with generic
using
statements (e.g.,using Unitful
) which makes it hard for people not familiar with the dependencies (e.g., me) to tell where some methods/definitions are coming from. By using explicit imports or qualified names (e.g.,using Unitful: m, <etc...>
orimport Unitful as u; u.m
we make this discovery process easier -- e.g., if I see an unqualifiedinterpolate
method being used in our code, I can go to the imports block and see where it is being imported from quickly.Similarly I would move import statements out of
include
d files likecolor_law.jl
anddust_maps.jl
and put all the imports in the same place at the module level in theDustExtinction.jl
file. Having all the imports in one place simplifies the process of auditing the dependencies so you don't have to crawl through all the source files to find all the import statements.I think this would improve maintainability / onboarding for new maintainers.
The text was updated successfully, but these errors were encountered: