usnews/smoketest

Add some code comments to top of `smoketest/settings.py`

Closed this issue · 1 comments

mcbridem commented

Looking at https://github.com/usnews/smoketest/blob/7719760610fc57c14571bdeaf02d0c3e4fe23ca7/smoketest/settings.py, I'm not sure it's immediately obvious to the code reader why _SETTINGS is set globally to None and then changed to {}. We could add an inline code comment to clarify that this is a caching and/or performance optimization, if that's the intention.

This issue is related to #22, where I suggested inserting an inline code comment in part of the _get_settings function.