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

getting-started.md: Replace user.Url with user.HtmlUrl #2996

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bryancandi
Copy link

@bryancandi bryancandi commented Jan 30, 2025

The HtmlUrl user property should be used rather than Url to view a user's profile link. The documentation explains that the code sample will provide a link to the user's profile page.

No issues resolved that I am aware of but it provides the appropriate link to view a user's profile page.


Before the change?

  • Output of user.Url returns a link that displays available API property values for the specified user.

After the change?

  • Output of user.HtmlUrl returns a link to the specified user's profile page.

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

The `HtmlUrl` user property should be used rather than `Url` to view a user's profile link.
@bryancandi bryancandi changed the title Replace user.Url with user.HtmlUrl getting-started.md: Replace user.Url with user.HtmlUrl Jan 30, 2025
@bryancandi
Copy link
Author

bryancandi commented Jan 31, 2025

Here are examples using my profile for clarification.

The correct profile link returned by user.HtmlUrl:
https://github.com/bryancandi

The API link returned by user.Url:
https://api.github.com/users/bryancandi

Hope this helps. I can provide test code if needed. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 Triage
Development

Successfully merging this pull request may close these issues.

1 participant