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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

spelling: character #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

spelling: character #3

wants to merge 1 commit into from

Conversation

jsoref
Copy link

@jsoref jsoref commented May 30, 2023

No description provided.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@lattner lattner requested a review from modocache May 30, 2023 21:29
@lattner
Copy link

lattner commented May 30, 2023

Seems obvious to me, but could you review Brian?

@modocache
Copy link
Collaborator

Thanks, great catch @jsoref!

This typo is also present in VS Code: https://github.com/microsoft/vscode/blob/main/extensions/python/syntaxes/MagicPython.tmLanguage.json#L1961

I think it would be even better to fix this there, so everyone using VS Code's syntax file benefits, and then we'll pull those changes into our syntax file. Would you mind sending them one, @jsoref? https://github.com/microsoft/vscode/pulls

@modocache modocache self-assigned this Jun 1, 2023
@jsoref
Copy link
Author

jsoref commented Jun 1, 2023

Frankly the VSCode team has been relatively hostile to contributions. (I've tried. I've also had much better experiences from a number of other Microsoft teams.)

Without someone volunteering to help me get contributions to VSCode accepted, I'm not interested in trying again. (If someone volunteers, I'm certainly willing.)

@modocache
Copy link
Collaborator

modocache commented Jun 1, 2023

Oh, sorry to hear it! I could make a commit with you as a co-author, and try sending and shepherding a pull request myself, on both of our behalf. Would that work?

@jsoref
Copy link
Author

jsoref commented Jun 1, 2023

Please be my guest. And I appreciate that you're willing to include credit and asking for confirmation (someone took some of my commits for VSCode and didn't include attribution, and afaict didn't really ask). In general, I don't actually care as my general goal is to not run into spelling mistakes when I use a product or interact with things the product created (e.g. here), but it is nice to be credited (and I really do appreciate being asked, because I could imagine not wanting to be credited in certain circumstances).

@modocache
Copy link
Collaborator

Great! Let me know if this commit works for you, and if so I'll send it as a pull request to vscode: microsoft/vscode@dad93a6

@jsoref
Copy link
Author

jsoref commented Jun 1, 2023

Looks good to me. :shipit:

@modocache
Copy link
Collaborator

Oh, I see, there's actually a clause in their contribution guidelines specifically recommending against fixing typos in source code:

Pull requests only fixing spell check errors in source code are not recommended.

It's a little frustrating I agree, but I feel we probably ought to respect their wishes if they're specifically calling out that they don't want contributions like that. So I think it'd be better to not send them anything.

So, that leaves us with our syntax file and our typo... please let me think about this a bit. We currently track VS Code's syntax file very closely, and introduce only changes that are specific to Mojo. These typos aren't Mojo-specific, so part of me thinks we should leave them as-is. On the other hand, it's frustrating to have typos.

In the meantime, I'll update our contribution instructions to also point people to the VS Code repository, in addition to the MagicPython project.

@modocache
Copy link
Collaborator

Speaking of, this typo exists in the MagicPython project, which VS Code uses. In fact, contributing there is probably the way to go here: https://github.com/MagicStack/MagicPython/blob/7d0f2b22a5ad8fccbd7341bc7b7a715169283044/grammars/MagicPython.tmLanguage

Shall I submit on our behalf there? Or would you like to, @jsoref?

@jsoref
Copy link
Author

jsoref commented Jun 1, 2023

If they have different contribution guidelines, I'm happy to look at their project, but I'm not in a hurry to get to it, and there's no harm in this being handled separately from my larger PR.

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