Fix stale comment in site.conf.dist referencing removed database.conf#3056
Open
xcompass wants to merge 1 commit into
Open
Fix stale comment in site.conf.dist referencing removed database.conf#3056xcompass wants to merge 1 commit into
xcompass wants to merge 1 commit into
Conversation
drgrice1
requested changes
Jul 14, 2026
Comment on lines
+134
to
+135
| # these variables define the database connection (they are used by | ||
| # lib/WeBWorK/DB.pm and the course management utilities). |
Member
There was a problem hiding this comment.
Please change this to
Suggested change
| # these variables define the database connection (they are used by | |
| # lib/WeBWorK/DB.pm and the course management utilities). | |
| # These variables define the database connection. |
Do not mention where in the code the variables are used. Someone configuring webwork2 does not need (or even want) to know that.
Member
Author
There was a problem hiding this comment.
Done — applied your suggestion; the comment is now just "These variables define the database connection." with no code references.
Member
|
I have to ask. What does |
The comment above the $database_* variables still says they "are used by database.conf", but conf/database.conf no longer ships. Replace it with a simple statement of what the variables are for: "These variables define the database connection."
xcompass
force-pushed
the
upstream-siteconf-stale-databaseconf-comment
branch
from
c3497d0 to
19ece11
Compare
Member
Author
|
Upstream means this repo. We forked and maintain our own fork. |
Member
|
I see. It is just a bit of an odd branch prefix to use when submitting to the updated repository. That is why I asked. |
drgrice1
approved these changes
Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comment-only fix in
conf/site.conf.dist: the header above the$database_*variables still says they "are used by database.conf", butconf/database.confno longer ships. Replace it with a simple statementof what the variables are for — "These variables define the database
connection." — so admins reading
site.conf.distaren't sent looking fora file that no longer exists.
No behavior is affected.
Testing
conf/database.conf/.distis absent on currentWeBWorK-2.21(anddevelop).