This repository has been archived by the owner. It is now read-only.

Explain :user means username, not ID. #543

Merged
merged 1 commit into from Jun 25, 2014

Conversation

Projects
None yet
2 participants
@cirosantilli
Contributor

cirosantilli commented Jun 24, 2014

It's the first question that comes to mind when you see :user, and that's the first place I searched for an answer.

@gjtorikian

This comment has been minimized.

Contributor

gjtorikian commented Jun 24, 2014

I only see two specific instances of :user on this page. It might be better to just substitute all :user strings with :username to avoid confusion, rather than the paragraph note.

@cirosantilli

This comment has been minimized.

Contributor

cirosantilli commented Jun 24, 2014

This would be a better solution, but it would still leave things unclear about the other parts of the documentation which still use :user: git grep :user shows up quite a few.

If they are all actually usernames, shall I perl -lapi it?

@gjtorikian gjtorikian merged commit 0709686 into github:master Jun 25, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details
@gjtorikian

This comment has been minimized.

Contributor

gjtorikian commented Jun 25, 2014

This would be a better solution, but it would still leave things unclear about the other parts of the documentation which still use :user: git grep :user shows up quite a few.

Indeed.

Per 66406d9, I've gone through and changed the (correct) references of :user to :username to make this clearer to readers.

Thanks for bringing this up! 🤘

@cirosantilli cirosantilli deleted the cirosantilli:username-not-id branch Jun 25, 2014

jatoben added a commit that referenced this pull request May 14, 2015

Merge pull request #543 from github/json-search-indexing
Search indexing API takes JSON input
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.