Corrected search index limitations explanation#39702
Corrected search index limitations explanation#39702ruchira-net wants to merge 1 commit intogithub:mainfrom
Conversation
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.
|
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. |
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 linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@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. |
|
@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. |
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: