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 Xcode source completion sample #35724

Merged
merged 8 commits into from
Dec 20, 2024
Merged

Conversation

jaroshevskii
Copy link
Contributor

Swift prefers camelCase style for functions.

Why:

This change ensures consistency with Swift's preferred camelCase naming convention for function names, aligning the documentation with the official Swift coding guidelines.

What's being changed:

The example function signature in the documentation is updated from PascalCase (CalculateDaysBetweenDates) to camelCase (calculateDaysBetweenDates). This adjustment reflects the naming conventions used in Swift:

Before:

func CalculateDaysBetweenDates(

After:

func calculateDaysBetweenDates(

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

Swift prefers camelCase style for functions
Copy link

welcome bot commented Dec 19, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 19, 2024
Copy link
Contributor

github-actions bot commented Dec 19, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md fpt
ghec
fpt
ghec

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review copilot Content related to GitHub Copilot and removed triage Do not begin working on this issue until triaged by the team labels Dec 19, 2024
@nguyenalex836
Copy link
Contributor

@jaroshevskii Thanks so much for opening a PR! I'll get this triaged for review ✨

felicitymay
felicitymay previously approved these changes Dec 20, 2024
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

Many thanks for raising this pull request to improve our docs. I particularly appreciated your clear description of the problem that you were fixing. ✨

I've made one suggestion to change the language for the code block to Swift, but otherwise this looks good to merge. 🚀

@@ -445,8 +445,8 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, type this function
signature in a Swift file:

```shell copy
func CalculateDaysBetweenDates(
```swift copy
Copy link
Contributor

Choose a reason for hiding this comment

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

Now I see why you didn't use Swift. I'll check why that's not included in our supported languages.

This comment was marked as spam.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've opened:

Once that's approved and merged, we can update your branch and merge this.

Copy link
Contributor

Choose a reason for hiding this comment

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

That looks better 🙂

Screenshot showing the updated content in the preview.

Copy link

@Moo021781 Moo021781 left a comment

Choose a reason for hiding this comment

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

I don't know

@felicitymay felicitymay removed the waiting for review Issue/PR is waiting for a writer's review label Dec 20, 2024
@felicitymay felicitymay added this pull request to the merge queue Dec 20, 2024
@felicitymay
Copy link
Contributor

felicitymay commented Dec 20, 2024

Thanks for your patience @jaroshevskii

My pull request needed a reviewer who's in a later time zone than me. However, that's now merged and your PR is also in the merge queue. Our updates will take a little while to get to production, but should be there before the weekend.

Merged via the queue into github:main with commit d1e2842 Dec 20, 2024
45 checks passed
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@felicitymay
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team copilot Content related to GitHub Copilot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants