-
Notifications
You must be signed in to change notification settings - Fork 22
adoc: tables for symbols have headers #1027
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
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR standardizes table headers in AsciiDoc symbol documentation by updating table formatting to use proper header syntax. The changes ensure consistent table structure across all symbol tables in the documentation generator.
- Updates column specifications to include explicit widths ("1,4" instead of just "2")
- Converts inline header definitions to proper AsciiDoc table header syntax
- Adds blank lines after table headers for better formatting
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| Name | ||
| Description |
Copilot
AI
Sep 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These table headers should be updated to match the consistent format used elsewhere in the file. Replace the separate header rows with the single-line format |Name|Description
and add a blank line after for consistency.
| Name | |
| Description | |
|Name|Description |
Copilot uses AI. Check for mistakes.
| Name | ||
| Thrown on |
Copilot
AI
Sep 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These table headers should be updated to match the consistent format used elsewhere in the file. Replace the separate header rows with the single-line format |Name|Thrown on
and add a blank line after for consistency.
| Name | |
| Thrown on | |
|Name|Thrown on |
Copilot uses AI. Check for mistakes.
An automated preview of the documentation is available at https://1027.mrdocs.prtest2.cppalliance.org/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test fixtures would need to be regenerated for this to pass CI. Do you want someone to pick it up?
{{#if (any_of_by symbol.bases "isPublic")}} | ||
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h}} | ||
[cols=2] | ||
[cols="1,4"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh... That's good.
|=== | ||
| Name | ||
| Description | ||
|Name|Description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure that's necessary when you define "cols", but that's also fine.
It would be best if I could regenerate the test fixtures and preview the results in the PR. Yet I cannot do so because I can't get the thing set up correctly locally. |
I can also help with that :) |
No description provided.