Skip to content

docs: point the comments at the modules they mean - #256

Merged
cigamit merged 1 commit into
ctrliq:mainfrom
blaipr:docs/point-the-comments-at-the-ascender-modules
Sep 22, 2026
Merged

cigamit merged 1 commit into
ctrliq:mainfrom
blaipr:docs/point-the-comments-at-the-ascender-modules

Conversation

@blaipr

@blaipr blaipr commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Eight comments across five files send a reader to awx/settings/production.py and awx/settings/defaults.py to see what they are overriding.

Neither path exists any more. The package rename moved them to ascender/settings/, and awx/ is a shim of one file. A comment naming a file that is not there is worse than no comment: the reader assumes they are looking in the wrong place rather than that the note is stale.

alternative/docker-compose/config/settings.py                        2
alternative/docker-compose/docker-compose.yml                        1
alternative/podman/config/settings.py                                2
alternative/services/roles/ascender_config/tasks/main.yml            1
alternative/services/roles/ascender_config/templates/settings.py.j2  2

Both replacement paths were checked to exist on the platform's main rather than assumed.

Comments only. Nothing changes what is loaded or when, and the changed YAML parses.

Four of the five files are also touched by #247, #250 or #255, on different lines.

Eight comments across five files send a reader to awx/settings/production.py
and awx/settings/defaults.py to see what they are overriding. Neither path
exists any more: the package rename moved them to ascender/settings/, and
awx/ is a shim of one file.

A comment that names a file which is not there is worse than no comment,
because the reader assumes they are looking in the wrong place rather than
that the note is stale.

Both paths checked against the platform's main before being written.

Comments only. Nothing here changes what is loaded or when.
@cigamit
cigamit merged commit f2d3b72 into ctrliq:main Sep 22, 2026
@cigamit cigamit self-assigned this Sep 22, 2026
@cigamit cigamit added the documentation Improvements or additions to documentation label Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants