Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor generated C++ documentation: Iterator/Future #589

Open
izmalk opened this issue Feb 7, 2024 · 2 comments
Open

Refactor generated C++ documentation: Iterator/Future #589

izmalk opened this issue Feb 7, 2024 · 2 comments

Comments

@izmalk
Copy link
Contributor

izmalk commented Feb 7, 2024

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

  1. TypeDB distribution: Core/Cloud
  2. TypeDB version:
  3. Environment: Linux/Mac/Windows/TypeDB Cloud/Google Cloud/AWS/Azure
  4. Studio version:
  5. Other details:

Reproducible Steps

  1. Generate the API reference for the C++ driver

  2. Insert the API reference into our documentation

  3. 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.

@izmalk
Copy link
Contributor Author

izmalk commented Feb 7, 2024

Screenshot 2024-02-07 at 10 20 36 Screenshot 2024-02-07 at 10 20 45 Screenshot 2024-02-07 at 10 21 03

@izmalk
Copy link
Contributor Author

izmalk commented Feb 7, 2024

This is what it looks like after manually fixing the headings, as suggested above.
Screenshot 2024-02-07 at 10 44 52

The resulting files are attached as an example: Archive.zip

@sync-by-unito sync-by-unito bot changed the title C++ API reference documentation for answers Refactor generated C++ documentation: Iterator/Future Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant