Skip to content
This repository has been archived by the owner on Jan 26, 2024. It is now read-only.

config.h vague comment #333

Closed
rogerxx opened this issue Nov 10, 2022 · 2 comments
Closed

config.h vague comment #333

rogerxx opened this issue Nov 10, 2022 · 2 comments
Labels
A: enhancement New feature or request

Comments

@rogerxx
Copy link

rogerxx commented Nov 10, 2022

/* If you want to use the windows key change this to WLR_MODIFIER_LOGO */
#define MODKEY WLR_MODIFIER_ALT
#define TAGKEYS(KEY,SKEY,TAG) \

The word "this" is extremely vague, the following syntax augmentation would be better:

/* If you want to use the windows key change this to WLR_MODIFIER_LOGO */
#define MODKEY WLR_MODIFIER_ALT
(blank line)
#define TAGKEYS(KEY,SKEY,TAG) \

I would just rewrite, and include a blank line if there should be one.
/* If you want to use the windows key for MODKEY, use WLR_MODIFIER_LOGO */

@rogerxx rogerxx added the A: enhancement New feature or request label Nov 10, 2022
@sevz17 sevz17 closed this as completed in b59c7f6 Nov 11, 2022
@sevz17
Copy link
Collaborator

sevz17 commented Nov 11, 2022

Thanks for reporting!, English isn't my first language and I am still learning it.

@rogerxx
Copy link
Author

rogerxx commented Nov 11, 2022

I picked this grammar tip up from somebody (obviously) speaking a foreign language, or somewhat fluent in more than one language. As I understand, pronouns and determiners are somewhat difficult to distinguish what somebody is talking specifically about, as foreign languages tends to get tricky with the pronouns/determiners. And, many tend to frown upon pronouns/determiners due to their vagueness. On the flip, some point the finger at not using such pronouns/determiners as being formal. Regardless, you'll likely see me doing my best when providing/typing documentation, to be concise and clear, unless I'm documenting something for myself, and am not publicly committing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants