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

Example documentation doesn't use an example domain #16269

Closed
edent opened this issue Feb 8, 2025 · 1 comment
Closed

Example documentation doesn't use an example domain #16269

edent opened this issue Feb 8, 2025 · 1 comment

Comments

@edent
Copy link
Contributor

edent commented Feb 8, 2025

Specify which documentation you found a problem with

curl_easy_setopt(curl, CURLOPT_URL, "HTTPS://your.favourite.ssl.site");

The problem

When this line of code was committed (23 years ago!) .site was not a valid TLD. Now it is.

Can I suggest changing HTTPS://your.favourite.ssl.site to HTTPS://secure.example.tld or HTTPS://secure.example.test or similar?

While it is unlikely someone would maliciously register ssl.site, it probably makes sense to have it as obvious as possible that the code is for a placeholder domain.

Happy to send a PR if you think it is useful.

@bagder
Copy link
Member

bagder commented Feb 8, 2025

Sure, please make it use example.com or even something using the .example TLD. Maybe there are other examples to fix as well?

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

Successfully merging a pull request may close this issue.

2 participants