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

doc: consistent formatting on python manual section #79631

Merged
merged 1 commit into from Feb 13, 2020

Conversation

@bhipple
Copy link
Contributor

@bhipple bhipple commented Feb 9, 2020

No material changes to docs, but trying to sanitize them for consistent
readability prior to looking at #75837.

  • Use * for lists instead of -. I have no opinion one way or the other, but
    the latter was only used in 1-2 places.
  • Pad the code blocks with whitespace.
  • Wrap to 80 characters, except for a few 1-liners that were only slightly over.
Motivation for this change
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.
No material changes to docs, but trying to sanitize them for consistent
readability prior to looking at #75837.

- Use `*` for lists instead of `-`. I have no opinion one way or the other, but
  the latter was only used in 1-2 places.
- Pad the code blocks with whitespace.
- Wrap to 80 characters, except for a few 1-liners that were only slightly over.
@flokli
Copy link
Contributor

@flokli flokli commented Feb 9, 2020

@bhipple can you add some rules to the .editorconfig matching the changes you did here?

@veprbl
veprbl approved these changes Feb 9, 2020
Copy link
Member

@veprbl veprbl left a comment

LGTM

@bhipple
Copy link
Contributor Author

@bhipple bhipple commented Feb 10, 2020

I've looked at all the .editorconfig settings here and don't see anything relevant:
https://editorconfig-specification.readthedocs.io/en/latest/#supported-pairs

Are you aware of any to add? The word wrapping around 80 characters is usually the default that most people have setup in their editrs, though I don't see a setting for it in editorconfig at any rate.

@flokli
Copy link
Contributor

@flokli flokli commented Feb 10, 2020

@bhipple I thought about maybe something like max_line_length = 80 for [*.md] files.

@bhipple
Copy link
Contributor Author

@bhipple bhipple commented Feb 11, 2020

From reading the documentation, max_line_length does not appear to be an option in .editorconfig, which seems a little surprising. That said, even if it did, I believe the default in most editors is 80 anyways, which might be why they don't have it.

@flokli
Copy link
Contributor

@flokli flokli commented Feb 13, 2020

@bhipple Hm, this only seems to be a suggestion, not a standard.

I see a big red line in my vim and line wrapping happens, but anyways - fine to not include it.

@flokli flokli merged commit a3779ce into NixOS:master Feb 13, 2020
12 checks passed
12 checks passed
Evaluation Performance Report Evaluator Performance Report
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A darwin-tested
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release-combined.nix -A tested
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A manual
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A options
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A manual
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A tarball
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A unstable
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
@bhipple bhipple deleted the bhipple:doc/python-formatting branch May 10, 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

3 participants
You can’t perform that action at this time.