Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into octfiles_tests
Browse files Browse the repository at this point in the history
  • Loading branch information
cbm755 committed Jan 22, 2019
2 parents 18633a5 + 02e92aa commit c454363
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 16 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@ octaveforge_pkg/
doctest.tar.gz
src/*.oct
src/*.o
*.o
*.oct
tmp/**

12 changes: 6 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Date: 2018-01-04
Author: various authors
Maintainer: Colin B. Macdonald <[email protected]>, Michael Walter <[email protected]>
Title: Documentation tests
Description: The Octave-Forge Doctest package finds specially-formatted
blocks of example code within documentation files. It then executes
the code and confirms the output is correct. This can be useful as part of
a testing framework or simply to ensure that documentation stays up-to-date
during software development.
Description: Find and run example code within documentation.
Formatted blocks of example code are extracted from documentation
files and executed to confirm their output is correct. This can be
part of a testing framework or simply to ensure that documentation
stays up-to-date during software development.
Depends: octave (>= 4.2.0)
Url: https://github.com/catch22/octave-doctest
Url: https://octave.sourceforge.io/doctest
License: BSD-3-Clause
3 changes: 2 additions & 1 deletion inst/doctest.m
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%% Copyright (c) 2010 Thomas Grenfell Smith
%% Copyright (c) 2011, 2013-2016 Michael Walter
%% Copyright (c) 2015-2017 Colin B. Macdonald
%% Copyright (c) 2015-2019 Colin B. Macdonald
%%
%% Redistribution and use in source and binary forms, with or without
%% modification, are permitted provided that the following conditions are met:
Expand Down Expand Up @@ -41,6 +41,7 @@
%% @item function;
%% @item class;
%% @item Texinfo file;
%% @item .oct/.mex compiled code;
%% @item directory/folder (pass @code{-nonrecursive} to skip subfolders);
%% @item cell array of such items.
%% @end itemize
Expand Down
17 changes: 8 additions & 9 deletions octave-doctest.metainfo.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2016 Colin B. Macdonald
Copyright 2016, 2019 Colin B. Macdonald
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
Expand All @@ -11,13 +11,12 @@ without any warranty.
<id>octave-doctest</id>
<extends>www.octave.org-octave.desktop</extends>
<name>Doctest</name>
<summary>Finds and tests example code within documentation</summary>
<summary>Find and run example code within documentation</summary>
<description>
<p>Finds specially-formatted blocks of example code within
documentation files. Then execute that code and confirm the
output is correct. This can be useful as part of a testing
framework or simply to ensure that documentation stays up-to-date
during software development.</p>
<p>Formatted blocks of example code are extracted from documentation
files and executed to confirm their output is correct. This can be
part of a testing framework or simply to ensure that documentation
stays up-to-date during software development.</p>
</description>
<keywords>
<keyword>development</keyword>
Expand All @@ -26,9 +25,9 @@ without any warranty.
<keyword>documentation</keyword>
</keywords>
<translation/>
<url type="homepage">http://octave.sourceforge.net/doctest</url>
<url type="homepage">https://octave.sourceforge.io/doctest</url>
<url type="bugtracker">https://github.com/catch22/octave-doctest/issues/new</url>
<metadata_license>FSFAP</metadata_license>-->
<metadata_license>FSFAP</metadata_license>
<project_license>BSD-3-Clause</project_license>
<developer_name>Octave-Forge Community</developer_name>
<update_contact>[email protected]</update_contact>
Expand Down

0 comments on commit c454363

Please sign in to comment.