Mercurial > octave
changeset 32498:24b6c777b7a5 stable
maint: Update check for undocumented functions in Octave manual.
* mk_undocumented_list: Add new exceptions for "bytecode", "desktop".
Change exceptions "lower", "upper" to "tolower", "toupper.
* doc/interpreter/module.mk (undocumented_list): Rewrite makefile rule for
undocumented_list to output clean text as to whether check passed or failed.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 24 Nov 2023 15:20:18 -0800 |
parents | 772f681026b5 |
children | 1ce9e2befc91 5fac69033835 |
files | doc/interpreter/doccheck/mk_undocumented_list doc/interpreter/module.mk |
diffstat | 2 files changed, 17 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/mk_undocumented_list Fri Nov 24 14:34:36 2023 -0800 +++ b/doc/interpreter/doccheck/mk_undocumented_list Fri Nov 24 15:20:18 2023 -0800 @@ -115,6 +115,9 @@ ################################################################################ # Exception list of functions not requiring a DOCSTRING ################################################################################ +# desktop : Remove when terminal widget is no longer experimental +# bytecode : Remove when VM is no longer experimental +################################################################################ __DATA__ angle bessel @@ -123,9 +126,11 @@ besselk bessely bug_report +bytecode chdir dbnext debug +desktop end exit F_DUPFD @@ -150,7 +155,6 @@ J j java2mat -lower lstat metaclass nan @@ -170,7 +174,8 @@ setenv slash thetaticks -upper +tolower +toupper ylabel ylim ytickangle
--- a/doc/interpreter/module.mk Fri Nov 24 14:34:36 2023 -0800 +++ b/doc/interpreter/module.mk Fri Nov 24 15:20:18 2023 -0800 @@ -475,6 +475,16 @@ rm -f $@-t $@ -cd $(srcdir)/%reldir%; $(PERL) ./doccheck/mk_undocumented_list > $(@F)-t mv $@-t $@ + [ -s $@ ] || rm -f $@ + @cd $(srcdir)/%reldir% ; \ + if ls undocumented_list >/dev/null 2>&1 ; then \ + echo "Undocumented function check failed"; \ + echo "Review doc/interpreter/undocumented_list"; \ + exit 1 ; \ + else \ + echo "Undocumented function check passed"; \ + fi + .PHONY: %reldir%/undocumented_list SPELLCHECK_FILES = $(MUNGED_TEXI_SRC:.texi=.scheck)