docs: Improving documentation for examples#275
Open
Siel wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds short rustdoc introductions to several Rust examples to make the intent of each example clearer (addressing issue #272’s request for narrative context alongside code).
Changes:
- Added
//!module-level documentation headers to multipleexamples/*.rsfiles describing what each example demonstrates. - Included run instructions where relevant for DSL JIT examples.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/sde_readme.rs | Adds a brief description of the minimal SDE workflow example. |
| examples/one_compartment.rs | Documents the comparison between analytical vs ODE solutions. |
| examples/ode_readme.rs | Adds a short overview of the minimal ODE workflow example. |
| examples/dsl_runtime_jit.rs | Documents runtime JIT compilation of an ODE model from DSL text (with run command). |
| examples/dsl_jit_analytical_covariates.rs | Documents JIT DSL vs analytical! parity check with covariates (with run command). |
| examples/covariates.rs | Describes time-varying covariates, lag time, and repeated dosing in an ODE model. |
| examples/analytical_readme.rs | Adds an overview of the analytical! macro example workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+3
| //! This example showcases the use of the `analytical!` macro to define a simple one-compartment model with first-order absorption, | ||
| //! and the basic workflow of creating a subject, defining parameters, and estimating predictions. | ||
|
|
Contributor
|
Bencher Report| Branch | 272-adding-explanations-for-the-examples |
| Testbed | mhovd-pgx |
⚠️ WARNING: Truncated view!The full continuous benchmarking report exceeds the maximum length allowed on this platform.
🚨 2 Alerts
🐰 View full continuous benchmarking report in Bencher
mhovd
approved these changes
Jun 18, 2026
mhovd
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Merging this PR should close #272