docbook / xslTNG

DocBook xslTNG Stylesheets
https://xsltng.docbook.org
MIT License
41 stars 20 forks source link

Documentation glitch: does `validate-with-relax-ng()` really return the current working directory? #499

Open cmsmcq opened 2 months ago

cmsmcq commented 2 months ago

In file src/guide/xml/ref-functions.xml, the reference entry for validate-with-relax-ng says its purpose is:

Returns the current working directory.

So does the reference manual. But the fuller description says it performs Relax NG validation and either raises an exception or returns a map with keys valid, document, and errors..

Descriptions in src/guide/xml/ch02.xml, src/test/resources/expected/chapter.003.html, and rc/test/resources/xml/chapter.003.xml say, more plausibly, that it performs Relax NG validation.

For what it's worth, blame says this part of the reference list is unchanged from the initial commit.