mmo-ref/mudlet
1
0
Fork 0
mirror of https://github.com/Mudlet/Mudlet synced 2026-08-13 18:26:27 -04:00
Code Issues Projects Releases Packages Wiki Activity

infrastructure: drop comments that restate the code beside them (#9681)

Browse source 
#### Brief overview of PR changes/additions
- Removed 8 comments that only repeated the statement or assertion
message next to them
- Kept 1 of the 16 identical copies of the `lua_next()` key-copy note in
`TLuaInterpreterMedia.cpp`
- Comment-only: zero code lines changed

#### Motivation for adding to Mudlet
Reading a comment and then the code that says the same thing is wasted
effort; the rationale comments that document real gotchas are all
untouched.

#### Other info (issues closed, discussion etc)
Result of a pass over the last month of commits on `development`. The
vast majority of comments added there explain *why* rather than restate
*what*, so this is deliberately a small diff.

**Test case:** `git diff development...HEAD` shows only comment lines
removed; build and test suites are unaffected.


Assisted-by: Claude:claude-opus-5
Signed-off-by: Vadim Peretokin <vadim.peretokin@mudlet.org>
This commit is contained in:
Vadim Peretokin 2026-08-11 08:06:16 +02:00 • committed by GitHub
parent ed37c8eec2
commit b741663a1c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 2 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

30
src/TLuaInterpreterMedia.cpp
View file

@ -442,8 +442,6 @@ int TLuaInterpreter::playMusicFileAsTableArgument(lua_State* L, const char* func
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -807,8 +805,6 @@ int TLuaInterpreter::playSoundFileAsTableArgument(lua_State* L, const char* func
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -980,8 +976,6 @@ int TLuaInterpreter::playVideoFileAsTableArgument(lua_State* L, const char* func
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key{lua_tostring(L, -1)};
lua_pop(L, 1);
@ -1255,8 +1249,6 @@ int TLuaInterpreter::getPlayingMusicAsTableArgument(lua_State* L, const char* fu
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1421,8 +1413,6 @@ int TLuaInterpreter::getPlayingSoundsAsTableArgument(lua_State* L, const char* f
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1518,8 +1508,6 @@ int TLuaInterpreter::getPlayingVideosAsTableArgument(lua_State* L, const char* f
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1651,8 +1639,6 @@ int TLuaInterpreter::getPausedSoundsAsTableArgument(lua_State* L, const char* fu
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1734,8 +1720,6 @@ int TLuaInterpreter::getPausedMusicAsTableArgument(lua_State* L, const char* fun
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1817,8 +1801,6 @@ int TLuaInterpreter::getPausedVideosAsTableArgument(lua_State* L, const char* fu
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -1996,8 +1978,6 @@ int TLuaInterpreter::stopMusicAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -2216,8 +2196,6 @@ int TLuaInterpreter::stopSoundsAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -2341,8 +2319,6 @@ int TLuaInterpreter::stopVideosAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -2452,8 +2428,6 @@ int TLuaInterpreter::pauseSoundsAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -2541,8 +2515,6 @@ int TLuaInterpreter::pauseMusicAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);
@ -2630,8 +2602,6 @@ int TLuaInterpreter::pauseVideosAsTableArgument(lua_State* L, const char* func)
break;
}
// read the key from a copy: lua_tostring() on the slot itself converts a
// numeric key in place, which makes the next lua_next() fail
lua_pushvalue(L, -2);
const QString key = QString{lua_tostring(L, -1)}.toLower();
lua_pop(L, 1);

1
src/TMedia.cpp
View file

@ -1246,7 +1246,6 @@ void TMedia::connectMediaPlayer(std::shared_ptr<TMediaPlayer>& player)
}
});
// Error connection
disconnect(player->mediaPlayer(), &QMediaPlayer::errorOccurred, nullptr, nullptr);
connect(player->mediaPlayer(), &QMediaPlayer::errorOccurred, this, [this, weakPlayer](QMediaPlayer::Error error, const QString& errorString) {
const auto lockedPlayer = weakPlayer.lock();

1
src/TMxpProcessor.cpp
View file

@ -390,7 +390,6 @@ TMxpProcessingResult TMxpProcessor::processMxpInput(char& ch, bool resolveCustom
return HANDLER_INSERT_ENTITY_LIT;
}
}
// ask for the next char
return HANDLER_NEXT_CHAR;
}

1
src/mudlet-lua/tests/Other_spec.lua
View file

@ -1091,7 +1091,6 @@ describe("Tests the timer API", function()
"a delay rounding up to a whole day wraps to a zero interval and must be rejected")
assert.is_truthy(tostring(err):find("bad argument #1", 1, true),
"the delay should be reported as the offending argument, got: " .. tostring(err))
-- while a delay still under the day once rounded stays acceptable
local id = trackTemp(tempTimer(86399.4, [[]]))
assert.is_true(id > 0, "a delay under the day once rounded should still be accepted")
assert.is_true(killTimer(id))

1
src/mudlet-lua/tests/Trigger_spec.lua
View file

@ -365,7 +365,6 @@ describe("Trigger processing", function()
_G.TrigSpec = {count = 0}
local id = tempExactMatchTrigger("exact_line_only", function() _G.TrigSpec.count = _G.TrigSpec.count + 1 end)
assert.is_number(id)
-- superset line must NOT match an exact trigger
feedTriggers("\nexact_line_only and more\n")
assert.is_equal(0, _G.TrigSpec.count, "an exact-match trigger must not fire on a superset line")
feedTriggers("\nexact_line_only\n")

1
test/DiscordTest.cpp
View file

@ -294,7 +294,6 @@ private slots:
++checked;
}
}
// All 22 Discord Lua API functions should have been categorised:
QVERIFY2(checked >= 22, qPrintable(qsl("only categorised %1 Discord Lua functions - has the source moved?").arg(checked)));
}

9
test/SecureStringUtilsTest.cpp
View file

@ -143,22 +143,17 @@ void SecureStringUtilsTest::testSecureMemoryClearing()
QString testString = "sensitive_data";
QString originalContent = testString;
// Clear the string
SecureStringUtils::secureStringClear(testString);
// String should be empty after clearing
QVERIFY(testString.isEmpty());
QVERIFY(testString != originalContent);
// Test QByteArray clearing
QByteArray testArray = "sensitive_bytes";
QByteArray originalArray = testArray;
SecureStringUtils::secureByteArrayClear(testArray);
QVERIFY(testArray.isEmpty());
QVERIFY(testArray != originalArray);
// Test std::string clearing
std::string testStdString = "sensitive_std_data";
std::string originalStdString = testStdString;

1
test/functional_tests/TFeedTriggersRecursionTest.cpp
View file

@ -97,7 +97,6 @@ private slots:
lua_pop(L, 1);
QVERIFY2(bufferContains(qsl("trigger '%1'").arg(loopTriggerId)), "Expected the abort message to name the offending trigger by its id");
// The trigger should have fired exactly up to the limit and no further.
host->getLuaInterpreter()->compileAndExecuteScript(qsl("echo('LOOPCOUNT='..loopCount..'\\n')"));
QVERIFY2(bufferContains(qsl("LOOPCOUNT=%1").arg(TriggerUnit::scmMaxProcessingDepth)), qPrintable(qsl("Expected the trigger to fire exactly %1 times").arg(TriggerUnit::scmMaxProcessingDepth)));
}

1
test/functional_tests/TelnetSgrDefaultColorTest.cpp
View file

@ -182,7 +182,6 @@ private slots:
QCOMPARE(brightChar->foreground(), mpHost->mLightRed);
}
// Regression guard: bold of an explicit color still brightens it.
void boldColorStillBrightens()
{
injectData(QByteArrayLiteral("\x1b[31;1mbright"));