Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct message level documentation #1489

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

soliton-
Copy link
Contributor

@soliton- soliton- commented Aug 21, 2023

I'll also check level usage in examples.

In

irssi/src/core/levels.c

Lines 25 to 49 in 07b971c

static const char *levels[] = {
/* clang-format off */
"CRAP",
"MSGS",
"PUBLICS",
"NOTICES",
"PUBNOTICES",
"SNOTES",
"CTCPS",
"ACTIONS",
"JOINS",
"PARTS",
"QUITS",
"KICKS",
"MODES",
"TOPICS",
"WALLOPS",
"INVITES",
"NICKS",
"DCC",
"DCCMSGS",
"CLIENTNOTICES",
"CLIENTCRAP",
"CLIENTERRORS",
"HILIGHTS",
there is also PUBNOTICES listed which is not mentioned. Not sure if that should also be added to the help.

@ailin-nemui
Copy link
Contributor

https://github.com/irchelp/irchelp.github.io/blob/3a33c4210baa62eac18ca7ed90fa9c22da634f57/clients/unix/ircii/irciiman.txt#L1738

I think Irssi accepts it with and without S

we can still change it I'm kinda indifferent here

@soliton-
Copy link
Contributor Author

Any unambiguous prefix works but I would expect the complete form in documentation.

@ailin-nemui
Copy link
Contributor

upon second thought, the correct form should probably be the one listed in https://github.com/irssi/irssi/blob/master/src/core/levels.h

the whole affair is a bit unfortunate I'm afraid

@soliton-
Copy link
Contributor Author

When using levels from Irssi scripts, you need to prepend the level with
'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'.

If this means we need to pretend the two lists are the same or that this primarily describes the scripts interface then there should be some hint about that or that will keep tripping people up IMO.

@soliton-
Copy link
Contributor Author

Up to you of course what you want to commit but I would at least be consistent in the examples. It's confusing to see PUBLIC and PUBLICS in /help ignore.

@ailin-nemui
Copy link
Contributor

I think it should be changed to PUBLIC everywhere, one way to do this could be to add some sort of special case to the bits2level function

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants