Skip to content

Commit c454363

Browse files
committed
Merge remote-tracking branch 'origin/master' into octfiles_tests
2 parents 18633a5 + 02e92aa commit c454363

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@ octaveforge_pkg/
22
doctest.tar.gz
33
src/*.oct
44
src/*.o
5+
*.o
6+
*.oct
57
tmp/**
68

DESCRIPTION

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Date: 2018-01-04
44
Author: various authors
55
Maintainer: Colin B. Macdonald <[email protected]>, Michael Walter <[email protected]>
66
Title: Documentation tests
7-
Description: The Octave-Forge Doctest package finds specially-formatted
8-
blocks of example code within documentation files. It then executes
9-
the code and confirms the output is correct. This can be useful as part of
10-
a testing framework or simply to ensure that documentation stays up-to-date
11-
during software development.
7+
Description: Find and run example code within documentation.
8+
Formatted blocks of example code are extracted from documentation
9+
files and executed to confirm their output is correct. This can be
10+
part of a testing framework or simply to ensure that documentation
11+
stays up-to-date during software development.
1212
Depends: octave (>= 4.2.0)
13-
Url: https://github.com/catch22/octave-doctest
13+
Url: https://octave.sourceforge.io/doctest
1414
License: BSD-3-Clause

inst/doctest.m

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
%% Copyright (c) 2010 Thomas Grenfell Smith
22
%% Copyright (c) 2011, 2013-2016 Michael Walter
3-
%% Copyright (c) 2015-2017 Colin B. Macdonald
3+
%% Copyright (c) 2015-2019 Colin B. Macdonald
44
%%
55
%% Redistribution and use in source and binary forms, with or without
66
%% modification, are permitted provided that the following conditions are met:
@@ -41,6 +41,7 @@
4141
%% @item function;
4242
%% @item class;
4343
%% @item Texinfo file;
44+
%% @item .oct/.mex compiled code;
4445
%% @item directory/folder (pass @code{-nonrecursive} to skip subfolders);
4546
%% @item cell array of such items.
4647
%% @end itemize

octave-doctest.metainfo.xml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
3-
Copyright 2016 Colin B. Macdonald
3+
Copyright 2016, 2019 Colin B. Macdonald
44
55
Copying and distribution of this file, with or without modification,
66
are permitted in any medium without royalty provided the copyright
@@ -11,13 +11,12 @@ without any warranty.
1111
<id>octave-doctest</id>
1212
<extends>www.octave.org-octave.desktop</extends>
1313
<name>Doctest</name>
14-
<summary>Finds and tests example code within documentation</summary>
14+
<summary>Find and run example code within documentation</summary>
1515
<description>
16-
<p>Finds specially-formatted blocks of example code within
17-
documentation files. Then execute that code and confirm the
18-
output is correct. This can be useful as part of a testing
19-
framework or simply to ensure that documentation stays up-to-date
20-
during software development.</p>
16+
<p>Formatted blocks of example code are extracted from documentation
17+
files and executed to confirm their output is correct. This can be
18+
part of a testing framework or simply to ensure that documentation
19+
stays up-to-date during software development.</p>
2120
</description>
2221
<keywords>
2322
<keyword>development</keyword>
@@ -26,9 +25,9 @@ without any warranty.
2625
<keyword>documentation</keyword>
2726
</keywords>
2827
<translation/>
29-
<url type="homepage">http://octave.sourceforge.net/doctest</url>
28+
<url type="homepage">https://octave.sourceforge.io/doctest</url>
3029
<url type="bugtracker">https://github.com/catch22/octave-doctest/issues/new</url>
31-
<metadata_license>FSFAP</metadata_license>-->
30+
<metadata_license>FSFAP</metadata_license>
3231
<project_license>BSD-3-Clause</project_license>
3332
<developer_name>Octave-Forge Community</developer_name>
3433
<update_contact>[email protected]</update_contact>

0 commit comments

Comments
 (0)