Skip to content

Conversation

vinniefalco
Copy link
Member

No description provided.

@vinniefalco vinniefalco requested a review from Copilot September 15, 2025 20:56
Copy link

@Copilot Copilot AI left a 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.

Comment on lines 116 to 117
| Name
| Description
Copy link

Copilot AI Sep 15, 2025

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.

Suggested change
| Name
| Description
|Name|Description

Copilot uses AI. Check for mistakes.

Comment on lines 178 to 179
| Name
| Thrown on
Copy link

Copilot AI Sep 15, 2025

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.

Suggested change
| Name
| Thrown on
|Name|Thrown on

Copilot uses AI. Check for mistakes.

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://1027.mrdocs.prtest2.cppalliance.org/index.html

Copy link
Collaborator

@alandefreitas alandefreitas left a 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"]
Copy link
Collaborator

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
Copy link
Collaborator

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.

@vinniefalco
Copy link
Member Author

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.

@alandefreitas
Copy link
Collaborator

Yet I cannot do so because I can't get the thing set up correctly locally.

I can also help with that :)

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

Successfully merging this pull request may close these issues.

3 participants