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

Update language display names #14282

Merged
merged 16 commits into from Sep 29, 2023
Merged

Conversation

saritai
Copy link
Contributor

@saritai saritai commented Sep 21, 2023

For issue: https://github.com/github/docs-content/issues/12061

Overall release: https://github.com/github/docs-content/issues/11174

I've updated the mentions of Java and Javascript to also include Kotlin and TypeScript, respectively. I have also updated the language identifiers in a few places to reflect the new keywords.

I didn't touch anything related to the VS Code extension right now, as I think changes for that are still unknown/in the works.

Questions for reviewers:

  • I wasn't sure whether to add 'Kotlin' into every single place that Java is mentioned, or whether some articles were specifically for Java only. For example, the articles in https://codeql.github.com/docs/codeql-language-guides/codeql-for-java/ - I added Kotlin into the title only for ones that already mentioned Kotlin, but wasn't sure about the others. Do let me know if these all apply to Kotlin as well and I should add it everywhere.
  • I wasn't sure if the the import statements like import java should now say import java-kotlin? For now I changed them to say that but let me know and I can change them back

@saritai saritai requested a review from a team as a code owner September 21, 2023 11:55
Copy link
Collaborator

@adityasharad adityasharad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes in the text and titles look good, but you are right to ask about imports -- those should not change.

docs/codeql/reusables/extractors.rst Outdated Show resolved Hide resolved
@saritai
Copy link
Contributor Author

saritai commented Sep 21, 2023

@adityasharad @henrymercer Thanks for the review! One thing - should all the Java articles in here https://codeql.github.com/docs/codeql-language-guides/codeql-for-java/ be updated to mention Kotlin throughout? I noticed some already did, but some didn't, so wasn't sure if that was on purpose...

@henrymercer
Copy link
Contributor

@adityasharad @henrymercer Thanks for the review! One thing - should all the Java articles in here https://codeql.github.com/docs/codeql-language-guides/codeql-for-java/ be updated to mention Kotlin throughout? I noticed some already did, but some didn't, so wasn't sure if that was on purpose...

That seems reasonable to me but @igfoo would know for sure.

@igfoo
Copy link
Contributor

igfoo commented Sep 25, 2023

One thing - should all the Java articles in here https://codeql.github.com/docs/codeql-language-guides/codeql-for-java/ be updated to mention Kotlin throughout? I noticed some already did, but some didn't, so wasn't sure if that was on purpose...

That seems reasonable to me but @igfoo would know for sure.

I think that would be OK. There are some places where Kotlin is a bit different, and some Kotlin examples would be good (notably the Javadoc page), but I think that that's covered by the beta warning.

@saritai
Copy link
Contributor Author

saritai commented Sep 25, 2023

Thanks @igfoo @henrymercer! I'll update the rest of the Java articles to also mention Kotlin in the headers/content, will do that tomorrow!

@saritai
Copy link
Contributor Author

saritai commented Sep 27, 2023

@henrymercer @igfoo @adityasharad Thanks again and apologies for the delay! I now updated all the Java language guides to include Kotlin in the titles and in some of the content. I also added the Kotlin beta note in most of the articles to make it clear.

If all looks good, if one of you can approve then I'll go ahead and merge this so it is in main for the next CLI release! 👍

henrymercer
henrymercer previously approved these changes Sep 28, 2023
docs/codeql/codeql-language-guides/javadoc.rst Outdated Show resolved Hide resolved
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Henry Mercer <henry.mercer@me.com>
henrymercer
henrymercer previously approved these changes Sep 29, 2023
@saritai saritai merged commit 178b5c1 into main Sep 29, 2023
7 checks passed
@saritai saritai deleted the saritai/update-language-display-names branch September 29, 2023 15:15
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

6 participants