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
docs: Fix WireGuard spelling #16293
docs: Fix WireGuard spelling #16293
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR looks good, but I wonder if we have a way to prevent adding Wireguard
again in the future. The spell file currently contains Wireguard
, I'm curious to see if it complains on your changes. But even if it does, we are likely to change it anyway to have wireguard
(all lowercase) in #16238, and this will result of Sphinx spellchecks being case insensitive :/.
8f0bb89
to
bb535eb
Compare
Experimenting with Sphinx's spell-check: The current
|
Good question, I don't have a good answer either. I at least updated the spelling in the dictionary. It's also complicated by the fact that we still have some uses of "Wireguard" in the |
Should these be updated, too? |
(Looking at the docs we can maybe implement some custom filter to allow either |
Probably, yes. But I want to do that in a separate PR, as it is a code change and I want to be sure to test that separately. |
So interestingly enough, now that I fixed the spelling in the dictionary, it seems to actually consider upper/lowercase (because I missed one):
|
According to WireGuard's Trademark Usage Policy [1], WireGuard must be written with a capital W and a capital G. [1] https://www.wireguard.com/trademark-policy/ Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
bb535eb
to
4c7c557
Compare
My understanding (from playing with it a little) is:
|
According to WireGuard's Trademark Usage Policy [1], WireGuard must be
written with a capital W and a capital G.
[1] https://www.wireguard.com/trademark-policy/