Skip to content

Conversation

@ruchira-net
Copy link

Updated the limitations section to remove references to public repositories deleted before the index was created as it's wrong to say deleted code before the index was created will be NOT be included. It will be included is the right thing to say and it's already explained in the sentence after that.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

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 an 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 and the changes look good in the review environment.

Updated the limitations section to remove references to public repositories deleted before the index was created as it's wrong to say deleted code before the index was created will be NOT be included. It will be included is the right thing to say and it's already explained in the sentence after that.
@welcome
Copy link

welcome bot commented Aug 6, 2025

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 Aug 6, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Aug 6, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
copilot/concepts/completions/code-referencing.md fpt
ghec
fpt
ghec

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

🤖 This comment is automatically generated.

@Sharra-writes
Copy link
Contributor

@ruchira-net Thanks for opening a PR! This reads to me more like hedging than a declaration (note the "may not be included"), just in case some results are missing for whatever reason. The next sentence also uses hedging language ("may return matches"). I will check in about the phrasing, but the way it's punctuated definitely reads like it was added after the fact. The sentence is actually pretty awkward, and should probably be revised even if that clause is left in.

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team copilot Content related to GitHub Copilot and removed triage Do not begin working on this issue until triaged by the team labels Aug 12, 2025
@Sharra-writes
Copy link
Contributor

@ruchira-net I've confirmed with the Copilot team that the information is accurate, but also written in a way that confuses them briefly, too. Essentially, the index takes a snapshot of things as they are at that moment. If you search for something deleted before that snapshot was taken, it's probably not going to appear in your search results, because the snapshot shows that it was deleted. If, however, you search for something deleted after the snapshot was taken, the snapshot still shows it's there, and so it probably will appear in your search results.

It is honestly a weird case to include, and they way it's inserted haphazardly makes me think that someone complained at some point about deleted code or repositories not showing up, and so that clause was inserted to explain why. I'm going to close this PR and instead try to make the paragraph clearer.

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.

2 participants