Skip to content

Commit

Permalink
maint: Update check for undocumented functions in Octave manual.
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
Rik committed Nov 24, 2023
1 parent 0db7915 commit 39ec64a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/interpreter/doccheck/mk_undocumented_list
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ exit(1);
################################################################################
# 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
Expand All @@ -123,9 +126,11 @@ besseli
besselk
bessely
bug_report
bytecode
chdir
dbnext
debug
desktop
end
exit
F_DUPFD
Expand All @@ -150,7 +155,6 @@ isfinite
J
j
java2mat
lower
lstat
metaclass
nan
Expand All @@ -170,7 +174,8 @@ rticks
setenv
slash
thetaticks
upper
tolower
toupper
ylabel
ylim
ytickangle
Expand Down
10 changes: 10 additions & 0 deletions doc/interpreter/module.mk
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,16 @@ octetc_DATA += \
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)
Expand Down

0 comments on commit 39ec64a

Please sign in to comment.