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.

Sign up for GitHub

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

Update readme.md #2414

Merged
merged 1 commit into from
Feb 25, 2023
Merged

Update readme.md #2414

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You can add the count of all your private contributions to the total commits cou

### Showing icons

To enable icons, you can pass `show_icons=true` in the query param, like so:
To enable icons, you can pass `&show_icons=true` in the query param, like so:

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Query params follow the structure ?first_param=something&second_param=123&third_param.... Only if show_icons is not the first param sent should you have &. Otherwise, you have to use ?. Order doesn't matter when sending query params, so if someone decides to have show_icons before the other params (or as the only param), then it doesn't need the &. Because of this ambiguity, documentation usually doesn't include ? and & and only mentions the param. Please feel free to reply if you have any questions.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized that all the other params in the README have been written with a &, so unless you're willing to change all the params, adding a & to show_icons would probably be the way to go. My bad, sorry!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized that all the other params in the README have been written with a &, so unless you're willing to change all the params, adding a & to show_icons would probably be the way to go. My bad, sorry!

Yes! The first param probably would be the username, so I think it is ok to include the "&" in every optional param.

```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
Expand Down