Skip to content

fix: add explanation for the logging feature under moderation - #6514

Merged
pajlada merged 10 commits into
Chatterino:masterfrom
Nikk0o:logging-explanation
Oct 5, 2025
Merged

pajlada merged 10 commits into
Chatterino:masterfrom
Nikk0o:logging-explanation

Conversation

@Nikk0o

@Nikk0o Nikk0o commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

Adds an explanation about the logging feature in the moderation tab.

Fixes #6258

@Nerixyz Nerixyz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the issue was opened, a few settings have been added to the logging feature. The page is now much denser:

Screenshot Screenshot

With this PR, there's a new line:

Screenshot Image

Bikeshed(?): Could the explanation be appended to the "Logs are saved at XYZ. They are saved as plain text files per channel, containing time and date as well as the message text."? Maybe the second sentence could be grayed out with <span style=...>....

Comment thread CHANGELOG.md Outdated
- Dev: Correct handling of eventsubs without any account. (#6503)
- Dev: Removed dependency to Qt5 Compatibility module by updating libcommuni. (#6500)
- Dev: Merged emote element flags from different providers into two. (#6511)
- Minor: Added a description for the logging option under moderation tab. (#6514)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this up to the other Minor entries.

@Nerixyz

Nerixyz commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

Are you also planning to update the wiki entry? That currently mentions "moderators" even though you don't need to be a moderator to save logs. That entry could also be a bit longer - possibly showing some example logs(?).

The Chatterino settings page could then link to the wiki entry for further information.

@Nikk0o

Nikk0o commented Oct 1, 2025

Copy link
Copy Markdown
Contributor Author

That sounds good. I was also thinking about making it a tooltip that shows up when you hover over the Enable option to take up less space. What do you think?

And yes, I will update the wiki, but I want to wait until this PR is merged to update the picture of the logging tab.

@Nerixyz

Nerixyz commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

I was also thinking about making it a tooltip that shows up when you hover over the Enable option to take up less space. What do you think?

The issue with tooltips is that you usually don't know it's there, unless there's some hint like a '?' icon or similar. Maybe others have an opinion on this.

auto description = logs.emplace<QLabel>(
"Logging saves the chat history in plain text "
"with time and date and emote codes.");
description->setStyleSheet("color: #bbb");

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be theme-dependant?

Comment thread src/widgets/settingspages/ModerationPage.cpp Outdated
@jupjohn

jupjohn commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

I feel leaving this as a label is fine. Moving it into a tooltip (even with a ? icon) makes it harder to know what this is at a glance.

@pajlada

pajlada commented Oct 1, 2025

Copy link
Copy Markdown
Member

I was also thinking about making it a tooltip that shows up when you hover over the Enable option to take up less space. What do you think?

The issue with tooltips is that you usually don't know it's there, unless there's some hint like a '?' icon or similar. Maybe others have an opinion on this.

I'd like to replicate Factorio's system where if we have a tooltip, we'd append a '?' icon next to it. CC @Mm2PL as I know we've discussed this before

@jupjohn

jupjohn commented Oct 1, 2025 •

Copy link
Copy Markdown
Contributor

I'd like to replicate Factorio's system where if we have a tooltip, we'd append a '?' icon next to it.

If this starts to get done application wide (so there's a user expectation of how it works,) then that would be nice!

EDIT: I still feel this shouldn't be a tooltip since it describes the whole page/feature instead of the single toggle control.

@pajlada

pajlada commented Oct 1, 2025

Copy link
Copy Markdown
Member

EDIT: I still feel this shouldn't be a tooltip since it describes the whole page/feature instead of the single toggle control.

Agreed - a label works fine here

@Nikk0o

Nikk0o commented Oct 1, 2025

Copy link
Copy Markdown
Contributor Author

I added the description next to the log path. Unfortunately, it still creates a new line because the text is too long, but I think it looks prettier than before.

I also want to make the tooltip show up only over the "Logs are saved at XYZ", but I couldn't find a way to do that and the text wrapping at the same time.

@Nerixyz

Nerixyz commented Oct 2, 2025 •

Copy link
Copy Markdown
Contributor

I'd like to replicate Factorio's system where if we have a tooltip, we'd append a '?' icon next to it.

For those unaware like me, here's an example: https://www.youtube.com/watch?v=idklVQ6dhUQ&t=150s
They have a (i) next to the setting label. If you hover over it, a tooltip immediately appears (similar to how we show tooltips in the chat).

Unfortunately, it still creates a new line because the text is too long, but I think it looks prettier than before.

That's totally fine. My concern was that if we have two labels, (1) we start two lines with "Log*" and (2) the space between them is too large. With one label that wraps, the space between the lines isn't that large.

@Nikk0o

Nikk0o commented Oct 2, 2025

Copy link
Copy Markdown
Contributor Author

Okay, I pushed the changes. Now it's only one label with the path and the explanation.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy made some suggestions

Comment thread src/widgets/settingspages/ModerationPage.cpp Outdated
@pajlada
pajlada enabled auto-merge (squash) October 5, 2025 11:57

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy made some suggestions

Comment thread src/widgets/settingspages/ModerationPage.cpp
@pajlada
pajlada merged commit 2c44a2e into Chatterino:master Oct 5, 2025
18 checks passed
@pajlada

pajlada commented Oct 5, 2025

Copy link
Copy Markdown
Member

Thank you! As a first-time contributor, you are now eligible to be listed in the About page in Chatterino.

If you want this, you can open a new PR where you modify the resources/contributors.txt file and add yourself to the list. Read the comments at the top for instructions.

babicekmarek pushed a commit to babicekmarek/streamally-chatterino that referenced this pull request Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve explanation about the Logging feature under Moderation

4 participants