typedb-driver
typedb-driver copied to clipboard
Refactor generated C++ documentation: Iterator/Future
Description
The answer section of the C++ driver API reference contains four new files:
Future__RETURN__NATIVE_PROMISE__HELPER__.adoc
Iterable__NATIVE_ITER__NATIVE_T__T__HELPER__.adoc
Iterator__NATIVE_ITER__NATIVE_T__T__HELPER__.adoc
typedefs.adoc
Adding these files to the C++ Driver API reference makes in-page navigation much harder.
The first three files add third-level headings, visible in the in-page table of contents, with very long and strangely looking names, like Future< RETURN, NATIVE_PROMISE, HELPER >
.
The fourth file adds about 30 different 3rd-level headings to the page, making the table of contents very long and barely usable (it fails to scroll for some reason).
Environment
- TypeDB distribution: Core/Cloud
- TypeDB version:
- Environment: Linux/Mac/Windows/TypeDB Cloud/Google Cloud/AWS/Azure
- Studio version:
- Other details:
Reproducible Steps
-
Generate the API reference for the C++ driver
-
Insert the API reference into our documentation
-
Build the docs and check the resulting API reference page
Expected result
Shorter 3rd level headings in the first three files, like Future
.
One 3rd level heading combining all other headings from the typedefs.adoc
file.
Additional information
Our Table of contents displays all 2nd and 3rd level headings on the page.
This is what it looks like after manually fixing the headings, as suggested above.
The resulting files are attached as an example: Archive.zip