Mercurial > octave-antonio
annotate scripts/miscellaneous/citation.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
16810
diff
changeset
|
1 ## Copyright (C) 2013-2015 Carnë Draug |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
2 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
4 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
8 ## your option) any later version. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
9 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
10 ## Octave is distributed in the hope that it will be useful, but |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
13 ## General Public License for more details. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
14 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
18 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
20 ## @deftypefn {Command} {} citation |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
21 ## @deftypefnx {Command} {} citation @var{package} |
16810
62fa28af2842
doc: add citation() to documentation.
Rik <rik@octave.org>
parents:
16178
diff
changeset
|
22 ## Display instructions for citing GNU Octave or its packages in publications. |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
23 ## |
16810
62fa28af2842
doc: add citation() to documentation.
Rik <rik@octave.org>
parents:
16178
diff
changeset
|
24 ## When called without an argument, display information on how to cite the core |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
25 ## GNU Octave system. |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
26 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
27 ## When given a package name @var{package}, display information on citing the |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
28 ## specific named package. Note that some packages may not yet have |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
29 ## instructions on how to cite them. |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
30 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
31 ## The GNU Octave developers and its active community of package authors have |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
32 ## invested a lot of time and effort in creating GNU Octave as it is today. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
33 ## Please give credit where credit is due and cite GNU Octave and its packages |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
34 ## when you use them. |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
35 ## |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
36 ## @end deftypefn |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
37 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
38 ## Author: Carnë Draug <carandraug+dev@gmail.com> |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
39 ## Idea and documentation from R's citation() (also under GPL) |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
40 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
41 function citation (package = "octave") |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
42 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
43 if (nargin > 1) |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
44 print_usage (); |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
45 else |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
46 display_info_file ("citation", package, "CITATION"); |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
47 endif |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
48 |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
49 endfunction |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
50 |
16810
62fa28af2842
doc: add citation() to documentation.
Rik <rik@octave.org>
parents:
16178
diff
changeset
|
51 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
52 ## Test input validation |
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
53 %!error citation (1, 2) |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
54 %!error <citation: PACKAGE must be a string> citation (1) |
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
diff
changeset
|
55 %!error <citation: package .* is not installed> citation ("__NOT_A_VALID_PKG_NAME__") |
16810
62fa28af2842
doc: add citation() to documentation.
Rik <rik@octave.org>
parents:
16178
diff
changeset
|
56 |