Skip to content

Add solve() docs examples#1179

Merged
cliffburdick merged 1 commit into
mainfrom
cburdick/solve-doc-examples
May 12, 2026
Merged

Add solve() docs examples#1179
cliffburdick merged 1 commit into
mainfrom
cburdick/solve-doc-examples

Conversation

@cliffburdick
Copy link
Copy Markdown
Collaborator

No description provided.

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 12, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@cliffburdick
Copy link
Copy Markdown
Collaborator Author

/build

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 12, 2026

Greptile Summary

This PR adds Sphinx documentation examples for the solve() linear algebra function by inserting example-begin/example-end markers and one-line descriptive comments into six existing tests in SolveDense.cu, then wiring them up in solve.rst via literalinclude directives.

  • Six examples are added covering: dense vector RHS, dense matrix RHS, use in a composed expression, batched vector RHS, batched matrix RHS, and in-place output.
  • The relative path ../../../../test/00_solver/SolveDense.cu from docs_input/api/linalg/other/solve.rst is correct (four levels up to the repo root).

Confidence Score: 5/5

Safe to merge — purely additive documentation change with no logic modifications.

All six literalinclude markers are correctly placed and named, the RST relative path resolves to the right file, and no test logic was altered. The only observation is that the batched examples (4 and 5) surface identical one-liners in the rendered docs, leaving readers without shape context.

No files require special attention.

Important Files Changed

Filename Overview
docs_input/api/linalg/other/solve.rst Adds six literalinclude blocks that pull doc examples from SolveDense.cu; relative path is correct, marker names match test file.
test/00_solver/SolveDense.cu Adds example-begin/end markers and one-line comments to five tests; test-1 markers pre-existed, only the comment was added.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    RST["solve.rst\n(6x literalinclude)"]
    CU["SolveDense.cu\nexample-begin/end markers"]

    RST -->|"example-begin solve-test-1"| T1["Dense vector RHS\n(X = solve(A, B)).run(exec)"]
    RST -->|"example-begin solve-test-2"| T2["Dense matrix RHS\n(X = solve(A, B)).run(exec)"]
    RST -->|"example-begin solve-test-3"| T3["In expression\n(X = solve(A, B) * C).run(exec)"]
    RST -->|"example-begin solve-test-4"| T4["Batched vector RHS\n(X = solve(A, B)).run(exec)"]
    RST -->|"example-begin solve-test-5"| T5["Batched matrix RHS\n(X = solve(A, B)).run(exec)"]
    RST -->|"example-begin solve-test-6"| T6["In-place RHS\n(B = solve(A, B)).run(exec)"]

    T1 & T2 & T3 & T4 & T5 & T6 --> CU
Loading

Reviews (1): Last reviewed commit: "Add solve docs examples" | Re-trigger Greptile

Comment thread test/00_solver/SolveDense.cu
@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage is 94.375%cburdick/solve-doc-examples into main. No base build found for main.

@cliffburdick cliffburdick merged commit ad63780 into main May 12, 2026
1 check passed
@cliffburdick cliffburdick deleted the cburdick/solve-doc-examples branch May 12, 2026 23:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants