You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
The titles in the front matter for directory pages don't conform to the directories they're being generated from.
To Reproduce
Generate yaml for the following files:
a/b/h1.hpp
a/c/h2.hpp
a/d/h3.hpp
The title for the a directory page is a as expected, but the title for the a/b directory page is also a. I would expect the title to be b.
This does not appear to be a problem if correct documentation already exists. Only when generating it for the first time.
Expected behavior
The expectation is that the titles in the directory pages mirror the directories they are generated from.
Desktop (please complete the following information):
OS: MacOS Catalina
Clang 10.0.0
Additional context
After looking into this a little it seems that a recent fix was introduced to write titles when generating the directory stubs, and that that has caused this issue. The create_directory_stub defines a static stub_json_k variable which always contained just layout set to directory. A change was introduced to also write the title, but the title is not always the same so the variable should not have remained static.
Making stub_json_k no longer static improves the directory naming, but is not sufficient (as far as I can tell) because the title should not always be the path::filename() of the directory being created. If the directory name is mangled, then the mangled name is written to the title field. Then, later, during the call to reconcile the mangled name already exists and prevents the correct, demangled name from being written to the title field of the merged node.
I have worked around this locally by (a) making stub_json_k a local variable in the create_directory_stub function, and (b) only writing the title for "true" ancestors. So when creating path directories for a/b/c. I only set the title for a and b, but not for c. It seems to work, but I can't really tell whether it's really tackling the core of the problem.
The text was updated successfully, but these errors were encountered:
Describe the bug
The titles in the front matter for directory pages don't conform to the directories they're being generated from.
To Reproduce
Generate yaml for the following files:
a/b/h1.hpp
a/c/h2.hpp
a/d/h3.hpp
The title for the
a
directory page isa
as expected, but the title for thea/b
directory page is alsoa
. I would expect the title to beb
.This does not appear to be a problem if correct documentation already exists. Only when generating it for the first time.
Expected behavior
The expectation is that the titles in the directory pages mirror the directories they are generated from.
Desktop (please complete the following information):
Additional context
After looking into this a little it seems that a recent fix was introduced to write titles when generating the directory stubs, and that that has caused this issue. The
create_directory_stub
defines a staticstub_json_k
variable which always contained justlayout
set todirectory
. A change was introduced to also write the title, but the title is not always the same so the variable should not have remained static.Making
stub_json_k
no longer static improves the directory naming, but is not sufficient (as far as I can tell) because the title should not always be thepath::filename()
of the directory being created. If the directory name is mangled, then the mangled name is written to the title field. Then, later, during the call toreconcile
the mangled name already exists and prevents the correct, demangled name from being written to the title field of the merged node.I have worked around this locally by (a) making
stub_json_k
a local variable in thecreate_directory_stub
function, and (b) only writing the title for "true" ancestors. So when creating path directories fora/b/c
. I only set the title fora
andb
, but not forc
. It seems to work, but I can't really tell whether it's really tackling the core of the problem.The text was updated successfully, but these errors were encountered: