Skip to content

cudaPackages: [doc] apply markdown lints to internal doc#270976

Merged
ConnorBaker merged 1 commit intoNixOS:masterfrom
yannham:doc/cuda-markdown-lint
Dec 12, 2023
Merged

cudaPackages: [doc] apply markdown lints to internal doc#270976
ConnorBaker merged 1 commit intoNixOS:masterfrom
yannham:doc/cuda-markdown-lint

Conversation

@yannham
Copy link
Contributor

@yannham yannham commented Nov 29, 2023

Description of changes

This cosmetic PR cleans up two internal (for maintainers) README files in the cuda-modules repository by applying markdown-lint suggestions, making them more readable in the editor IMHO (while it should not change the representation for common mark viewer, beside one trivial rewording). This is a preliminary pass before adding documentation about cuda_compat.

It's currently based on #256324, as the latter changes the documentation as well.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Priorities

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: python Python is a high-level, general-purpose programming language. 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog This PR adds or changes release notes 6.topic: rust General-purpose programming language emphasizing performance, type safety, and concurrency. 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. 6.topic: stdenv Standard environment 6.topic: systemd Software suite that provides an array of system components for Linux operating systems. labels Nov 29, 2023
@yannham yannham changed the base branch from master to staging November 29, 2023 16:49
@github-actions github-actions bot removed 6.topic: python Python is a high-level, general-purpose programming language. 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: changelog This PR adds or changes release notes 6.topic: rust General-purpose programming language emphasizing performance, type safety, and concurrency. 6.topic: ocaml OCaml is a general-purpose, high-level, multi-paradigm programming language. 6.topic: stdenv Standard environment 6.topic: systemd Software suite that provides an array of system components for Linux operating systems. labels Nov 29, 2023
@ofborg ofborg bot added 2.status: merge conflict This PR has merge conflicts with the target branch and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Nov 29, 2023
@ConnorBaker ConnorBaker added the 6.topic: cuda Parallel computing platform and API label Nov 30, 2023
@yannham yannham force-pushed the doc/cuda-markdown-lint branch from 811a9bf to a39043f Compare December 12, 2023 09:39
@yannham yannham changed the base branch from staging to master December 12, 2023 09:39
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 6.topic: vim Advanced text editor 6.topic: lib The Nixpkgs function library and removed 8.has: documentation This PR adds or changes documentation 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 6.topic: vim Advanced text editor labels Dec 12, 2023
@github-actions github-actions bot removed the 6.topic: lib The Nixpkgs function library label Dec 12, 2023
@yannham yannham marked this pull request as ready for review December 12, 2023 09:40
@ofborg ofborg bot added 2.status: merge conflict This PR has merge conflicts with the target branch 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Dec 12, 2023
@ConnorBaker ConnorBaker self-requested a review December 12, 2023 15:00
@ConnorBaker ConnorBaker mentioned this pull request Dec 12, 2023
Closed
13 tasks
@ConnorBaker ConnorBaker merged commit 79f1a4f into NixOS:master Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ConnorBaker ConnorBaker ConnorBaker approved these changes

Assignees

No one assigned

Labels

6.topic: cuda Parallel computing platform and API 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux.

Projects

CUDA Team
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@yannham @ConnorBaker