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

Jump to bottom

Improve table for Understanding the search syntax, exclude certain results #11396

Open
1 task done
HonkingGoose opened this issue Oct 24, 2021 · 4 comments · May be fixed by #11894
Open
1 task done

Improve table for Understanding the search syntax, exclude certain results #11396

HonkingGoose opened this issue Oct 24, 2021 · 4 comments · May be fixed by #11894
Labels
content good first issue help wanted
Projects
Docs team reviews

Comments

Assignees
No one assigned
Labels
content good first issue help wanted
Projects
Docs team reviews
Help wanted
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

Keep simpler example, fix table formatting
6 participants
@jules-p @ramyaparimi @HonkingGoose @AnilSeervi and others
@HonkingGoose
Copy link
Contributor

@HonkingGoose HonkingGoose commented Oct 24, 2021 •
edited by jules-p
Loading

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#exclude-certain-results

What part(s) of the article would you like to see updated?

Current table

Copy/pasted from source file: 1

Query Example
-QUALIFIER cats stars:>10 -language:javascript matches repositories with the word "cats" that have more than 10 stars but are not written in JavaScript.
mentions:defunkt -org:github matches issues mentioning @defunkt that are not in repositories in the GitHub organization

Expected table

I was expecting the second row to look similar to this:

Query Example
-QUALIFIER cats stars:>10 -language:javascript matches repositories with the word "cats" that have more than 10 stars but are not written in JavaScript.
mentions:defunkt -org:github matches issues mentioning @defunkt that are not in repositories in the GitHub organization

Additional information

No response

Added by maintainer

These are two examples of the same qualifier, with a missing | which is messing up the formatting. We don't need two examples, and the mentions:defunkt -org:github example is a little simpler and more accessible, so let's keep that one, moving it to where the cats stars:>10 -language:javascript example was, and remove the bottom row of the table.

Footnotes

  1. https://github.com/github/docs/blob/main/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md ↩
@github-actions github-actions bot added this to Triage in Docs team reviews Oct 24, 2021
@ramyaparimi
Copy link
Collaborator

@ramyaparimi ramyaparimi commented Oct 25, 2021

@HonkingGoose
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

Loading

@jules-p
Copy link
Contributor

@jules-p jules-p commented Nov 9, 2021

Thanks for opening this @HonkingGoose, you're right that this needs to be updated ✨ I've made an edit to the OP with a summary of what to change, you (or anyone else) is welcome to open a PR to address that change. Thank you 🎉

Loading

@docubot docubot moved this from Triage to Help wanted in Docs team reviews Nov 9, 2021
@HonkingGoose
Copy link
Contributor Author

@HonkingGoose HonkingGoose commented Nov 9, 2021

Thank you for the edit! I'll let somebody else fix this with a pull request.

Loading

@AnilSeervi AnilSeervi linked a pull request that will close this issue Nov 12, 2021
Open
5 tasks
@AnilSeervi
Copy link
Contributor

@AnilSeervi AnilSeervi commented Nov 12, 2021

Opened #11894 with the suggested changes by the maintainer.

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment