Add .NET examples to documentation / update docs#2027
Merged
speth merged 7 commits intoCantera:mainfrom Nov 3, 2025
Merged
Conversation
ischoegl
force-pushed
the
some-doc-updates
branch
from
76721b7 to
8737781
Compare
5 tasks
Renamed for documentation purposes, specifically Sphinx-gallery. While Program.cs is the conventional name for the application's entry point, the compiler doesn't care.
ischoegl
force-pushed
the
some-doc-updates
branch
from
8737781 to
6fda0f7
Compare
ischoegl
changed the title
speth
requested changes
Oct 31, 2025
Comment on lines
+1
to
+4
| .NET Examples | ||
| ============= | ||
|
|
||
| Examples illustrating Cantera's .NET API are written in C#. |
Member
There was a problem hiding this comment.
I'm a little unclear on how we want to label these examples. Are they "C# examples", or ".NET examples"? Maybe @burkenyo can weigh in on what the right terminology is here.
Member
Author
There was a problem hiding this comment.
I went back and forth on this and settled on .NET for the API, and C# for the language (which I believe was the intent). The examples are C# as we're not providing the csproj files in the links.
ischoegl
force-pushed
the
some-doc-updates
branch
from
03d2ff9 to
7fe4afc
Compare
Member
Author
|
@speth ... I feel fairly confident about the .NET terminology, as the examples are based on .NET project files. What is added to the gallery are only the C# files. Let me know if you have any other requests. |
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
2 participants
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.
Changes proposed in this pull request
If applicable, fill in the issue number this pull request is fixing
Closes #2025, closes #2022
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build&scons test) and unit tests address code coverage