The usage of scan_dirs is incorrectly documented

[james-d-mitchell]

Thanks for the great project, I'm just starting to use this in the Semigroups package.

From the manual it seems like it should be possible to include a scan_dirs component in the gapdoc record passed to AutoDoc:

AutoDoc/gap/Magic.gd

Line 300 in 06727a4

#! <Mark><A>scan_dirs</A></Mark>

AutoDoc/doc/Tutorials.xml

Line 286 in 06727a4

AutoDoc( rec( gapdoc := rec( scan_dirs := [ "package_sources" ] ) ) );

But this doesn't work (I mean that the directory is not scanned). This only seems to work when scan_dirs is in the autodoc component.

[fingolfin]

The code is there and it used to work for sure: all .g .gd and .gi files should be found. Huh

[james-d-mitchell]

I release I haven't posted a minimal failing example, I'll try to come up with one and post that.

[fingolfin]

Don't worry about that. I'll try to reproduce it tomorrow. Either it'll work for me on some package (then we can compare what's different to your setup), or I'll quickly repro the issue.

[fingolfin]

(I mean, of course if you post something, that'll probably be helpful; but as it is, I think you report is sufficient to look into this; it's mostly a matter of finding the time).

[fingolfin]

Just to avoid a misunderstanding: the two scan_dirs have different jobs, one scans for autodoc comments, the other scans for GAPDoc comments

[fingolfin]

@james-d-mitchell I should point out that recog uses this option successfully in both the gapdoc and the autodoc record.

So at this point I am at a loss what exactly the problem is you observed. I need more details, otherwise there is nothing I can do.