research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Adjust example docstrings to get better automatic summaries

Browse source
This commit is contained in:
Ray Speth 2016-10-14 17:20:18 -04:00
parent 0c1eb4cd89
commit ac771aaac5
3 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
samples/matlab/cantera_demos.m
View file

@ -1,3 +1,4 @@
% Run all examples
ctpath;
cd ../demos/matlab;
run_examples;

9
samples/matlab/periodic_cstr.m
View file

@ -1,11 +1,10 @@
function periodic_cstr
%
% Periodic CSTR
% A CSTR with steady inputs but periodic interior state.
%
% This example illustrates a CSTR with steady inputs but periodic
% interior state. A stoichiometric hydrogen/oxygen mixture is
% introduced and reacts to produce water. But since water has a
% large efficiency as a third body in the chain termination reaction
% A stoichiometric hydrogen/oxygen mixture is introduced and reacts to produce
% water. But since water has a large efficiency as a third body in the chain
% termination reaction
%
% H + O2 + M = HO2 + M
%

5
samples/matlab/rankine.m
View file

@ -1,9 +1,6 @@
function [work, efficiency] = rankine(t1, p2, eta_pump, eta_turbine)
%
% RANKINE
%
% This example computes the efficiency of a simple vapor power
% cycle.
% This example computes the efficiency of a simple vapor power cycle.
%
help rankine