Mercurial > octave
annotate CITATION @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 347dbc9049d5 |
children | 04120d65778a |
rev | line source |
---|---|
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
1 To cite GNU Octave in publications use: |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
2 |
28654
844b3b9bab7a
bump version for first 6.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
27995
diff
changeset
|
3 John W. Eaton, David Bateman, Søren Hauberg, Rik Wehbring (2020). |
30596
347dbc9049d5
bump version for first 7.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
30270
diff
changeset
|
4 GNU Octave version 7.1.0 manual: a high-level interactive language for |
18759
a6d13c62fccf
Update CITATION file to include Rik Wehbring, use current version number.
Rik <rik@octave.org>
parents:
16178
diff
changeset
|
5 numerical computations. |
30596
347dbc9049d5
bump version for first 7.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
30270
diff
changeset
|
6 URL https://www.gnu.org/software/octave/doc/v7.1.0/ |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
7 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
8 A BibTeX entry for LaTeX users is: |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
9 |
22444
d77caa2d523d
CITATION: update for 4.2.0 and use @manual in Bibtex (bug #47058).
Rik <rik@octave.org>
parents:
20201
diff
changeset
|
10 @manual{, |
30596
347dbc9049d5
bump version for first 7.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
30270
diff
changeset
|
11 title = {{GNU Octave} version 7.1.0 manual: a high-level interactive language for numerical computations}, |
22932
06513f1f90af
* CITATION: Use 'and' instead of comma to separate author names.
John W. Eaton <jwe@octave.org>
parents:
22929
diff
changeset
|
12 author = {John W. Eaton and David Bateman and S{\o}ren Hauberg and Rik Wehbring}, |
30596
347dbc9049d5
bump version for first 7.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
30270
diff
changeset
|
13 year = {2022}, |
347dbc9049d5
bump version for first 7.1 release candidate
John W. Eaton <jwe@octave.org>
parents:
30270
diff
changeset
|
14 url = {https://www.gnu.org/software/octave/doc/v7.1.0/}, |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
15 } |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
16 |
25771 | 17 We have invested a lot of time and effort in creating GNU Octave, please |
27216
823b4bcf79fc
unless necessary for formatting or code, use ' instead of `
John W. Eaton <jwe@octave.org>
parents:
26290
diff
changeset
|
18 cite it when using it. See also 'citation pkgname' for citing Octave |
25771 | 19 packages. |