Create Slash.yml #111
Create Slash.yml #111
Conversation
|
I'm a bit afraid this rule would need a lot of maintenance to add every exception needed At least you used suggestion level |
|
I will try to run it on my code base. But I can at least can think about CPU architecture:
More example here |
Absolutely, which is why I put suggestion as the level and added a generalized message. |
Different organizations may have different principles. In this case, SUSE appears to approach acceptable slashes cautiously. So, for now at least, I don't think we should add anything that wasn't explicitly allowed in the style guide to the rule here. I thought about adding a lot of other stuff as well, but we should consider those within jargonLint/jargonLint/discussions/33. If a larger rule there becomes useful, then we can suggest it here as well. |
|
Make sense |
|
@ccoVeille I understand your frustration with the rule's current limitations, but I'd still argue that the rule serves its purpose of warning users not to use slashes. It is not perfectly thorough, though for such a simple rule, that doesn't strike me as a problem. Slash rules are fairly popular in other Vale repositories as well, and most of them will prompt more false positives than this one. For my part, I used it in Kanidm, which is under openSUSE and the rule was useful. Filenames as in I'd also prefer not to dwell too much on the rule, like we did in Latin.yml(#103). This rule isn't perfect and, in the short term at least, that should be acceptable. |
|
I agree and accept your detailed explanations. The problem I'm struggling with is the existence of suse "no slash" rule, more than your implementation |
|
@ccoVeille Is there anything else you want to add? |
|
@tbazant this branch seems ready to merge. I've also added test files, sorry for neglecting those in earlier rules. |
Co-authored-by: ccoVeille <[email protected]>
|
@dariavladykina do we have strong opinions about using slashes? if so, does it align with suggested changes? |
Just to be clear, I try to add rules that SUSE clearly asks for in the language section while keeping exceptions limited to what is explicitly allowed. |
|
All of these additions for good and bad slash uses seem OK to me. Do we also have a rule to not use space around slashes? I.e. to avoid |
Yes, the regexp matches and therefore disallows them, which I had to write for my main project Kanidm, where we previously used and need to correct a lot of those. The |
I added the slash rule.
I also inelegantly added exceptions for both "AMD64/Intel 64" and "Wi-Fi/Bluetooth card" since their use was suggested in the style guide.