Skip to content

Better error message when chapter or section name contains invalid character #77

@fingolfin

Description

@fingolfin

I wrote some documentation and dared to put a colon into a chapter title. This triggered the following error:

Generating documentation in Directory("/PATH/TO/doc/")
Error, <name> must not contain '\' or ':' called from
Filename( arg[1], arg[2] ) called from
AUTODOC_OutputTextFile( path_to_xmlfiles, filename ) called from
WriteDocumentation( i, stream, path_to_xmlfiles ); called from
WriteDocumentation( tree, doc_dir ); called from
<function "AutoDoc">( <arguments> )
 called from read-eval loop at line 21 of makedoc.g
you can 'quit;' to quit to outer loop, or
you can 'return;' to continue
brk>

That is not very helpful. I had written a big chunk of stuff, and part of it contained a backslash. After removing that, I still got errors, and it took me some time that I should search for a colon...

I think we should check chapter and section names the moment we read them in, and immediately print an error at that point, if necessary -- including filename, line and the precise string that was read...

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions