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

treewide: remove package names from prefix of descriptions #101733

Merged
merged 1 commit into from Oct 27, 2020

Conversation

@siraben
Copy link
Member

@siraben siraben commented Oct 26, 2020

Motivation for this change

Part of #97685.

I edited the files by hand (!), roughly according to these rules

  • "X is a(n) ..." -> "A(n) ..."
  • "X, a(n) ..." -> "A(n) ..."
  • fixed grammatical errors/minor rephrasing
  • if the first word referred to a protocol/trademark, did not remove

I had to cleanup whitespace in three files, due to ofborg complaining.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
@siraben
Copy link
Member Author

@siraben siraben commented Oct 26, 2020

Some things that may need to be clarified in CONTRIBUTING.md if we want to be consistent across tens of thousands of packages;

  • Some descriptions start with definite/indefinite articles (i.e. "a" or "the") or none at all
  • Some descriptions consist of more than one independent clause, make it a rule to move into longDescription?
  • Maintaining neutrality in descriptions, I saw phrases such as "very simple" tool or "highly addictive" game

Copy link
Contributor

@jonringer jonringer left a comment

LGTM

Thanks for doing this! :)

@jonringer
Copy link
Contributor

@jonringer jonringer commented Oct 26, 2020

Some things that may need to be clarified in CONTRIBUTING.md if we want to be consistent across tens of thousands of packages;

* Some descriptions start with definite/indefinite articles (i.e. "a" or "the") or none at all

* Some descriptions consist of more than one independent clause, make it a rule to move into `longDescription`?

* Maintaining neutrality in descriptions, I saw phrases such as "very simple" tool or "highly addictive" game

Hmm, agreed in general.

I think the intent is, "does it concisely describe the package". There's a little bit of "literary freedom", but I wouldn't want to be pedantic to the point of dissuading potential contributors.

@jonringer
Copy link
Contributor

@jonringer jonringer commented Oct 27, 2020

I don't see anyone violently against this, I think I'll merge this before it gets into merge conflict limbo

@jonringer jonringer merged commit db74029 into NixOS:master Oct 27, 2020
16 checks passed
@siraben siraben deleted the prefix-fix branch Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants