[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[OF] Docs, Demos and Test for External package
From: |
Juan Pablo Carbajal |
Subject: |
[OF] Docs, Demos and Test for External package |
Date: |
Fri, 17 Feb 2017 00:38:32 +0100 |
Hi all,
I am setting up an external OF package
https://bitbucket.org/KaKiLa/gpml
the new Makefile runs flawlessly and I am able to install the package.
Now because this is package built form code meant for Matlab there are
several things that aren't present in the created package:
1. Documentation (I mean texinfo strings)
2. Demos
3. Tests
This prevents a nice html help automatically generated and 'make
check' is useless.
How would you suggest I include these missing things?
a. For demos and test I could create extra files with the demo/test
code and concatenate them at packaging time. E.g. "covSEiso.m" would
have test and demos in "octave_pkg/covSEiso.otd" (a plan text file)
and at packaging time I would do "cat octave_pkg/covSEiso.otd >>
$(RELEASE_DIR)/inst/cov/covSEiso.m"
b. I am a little blocked with the docstrings. The problem is that the
functions already have documentation. I could nevertheless make a
Octave-style copyright and documentation and insert it above the
current function definition. This seems to work alright in the
following dummy example, but duplicates the content of the file. What
do you think?
# Copyright
#
#
# Author:
# -*- texinfo -*-
# @defun {y =} tt(@var{x})
# A simple documentation of @command{tt} that takes the input @var{x}
# @end defun
function y = tt(x)
% Y = TT(X)
% A simple documentation of TT that takes the input X
y = x;
endfunction
Thanks
- [OF] Docs, Demos and Test for External package,
Juan Pablo Carbajal <=