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

Replace short URL from #63103 with full URL. #77768

Merged
merged 1 commit into from Jan 15, 2020
Merged

Replace short URL from #63103 with full URL. #77768

merged 1 commit into from Jan 15, 2020

Conversation

dhess
Copy link
Contributor

@dhess dhess commented Jan 15, 2020

It's polite to show a user where a URL is taking them before they follow it. Also, the message is already (helpfully) verbose, so there's not much benefit in using a shortener in the first place.

This change also makes the documentation consistent with existing practice when referring to GitHub pull requests in user-visible strings; see, for example:

"Also see https://github.com/NixOS/nixpkgs/pull/44903"

"See: https://github.com/NixOS/nixpkgs/pull/57681#issuecomment-475857499"

"Numerous and uncounted, upstream has requested we not package it. See more: https://github.com/NixOS/nixpkgs/pull/23058#issuecomment-283515104"

The error message is already helpfully verbose, so there's little
reason to shorten the informational URL.
@@ -406,7 +406,7 @@ rec {
In file ${def.file}
a list is being assigned to the option config.${option}.
This will soon be an error as type loaOf is deprecated.
See https://git.io/fj2zm for more information.
See https://github.com/NixOS/nixpkgs/pull/63103 for more information.
Copy link
Member

Choose a reason for hiding this comment

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

Should we wrap this at more?

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 thought about it, but decided instead to go with the idea that the original author intended there to be one full sentence per line. (The templated bits in the displayed message often greatly exceed the line length of the line I added.)

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

Successfully merging this pull request may close these issues.

None yet

3 participants