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

add "Flags" title in format parameter of sprintf #4551

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sad270
Copy link

@sad270 sad270 commented Mar 20, 2025

In format parameter of sprintf function, there is no title for the flags parameters.

BEFORE
Flags seems to be for Argnum parameter
Screenshot 2025-03-20 at 14 48 38

AFTER
(I make the change with my browser inspector)
Flags are in a flags section, we understand that it's for flags
Screenshot 2025-03-20 at 14 49 58

@tiffany-taylor
Copy link
Member

"Flags" as a title already appears on the page, but it shows as a centered title above the table, which is confusing to readers.

Could you correct that instead of your current suggestion, please?

@sad270
Copy link
Author

sad270 commented Apr 3, 2025

I have to surround the section with formalpara. I will do it in some hours 😄

@sad270
Copy link
Author

sad270 commented Apr 3, 2025

Hi @tiffany-taylor
The second "Flags" is the table title. When I remove it, my document didn't validate.

I have those errors :

The document didn't validate
/phpdoc/doc-base/.manual.xml:1159609:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1165383:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1167215:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1176744:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1177258:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1177769:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"

IMO we have to have both (section and table titles). It will be weird to have the title twice but less confusing than not have section title. WDYT ?

</para>
<formalpara>
<title>Flags</title>
<para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need this wrapping para tag

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran your suggestions locally. The <para> container is still needed, but <table> can safely be changed to <informaltable>.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines 3963 to 3964
<table>
<title>Flags</title>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<table>
<title>Flags</title>
<informaltable>

And fix the end tag

@tiffany-taylor
Copy link
Member

Hi @tiffany-taylor The second "Flags" is the table title. When I remove it, my document didn't validate.

I have those errors :

The document didn't validate
/phpdoc/doc-base/.manual.xml:1159609:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1165383:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1167215:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1176744:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1177258:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"
/phpdoc/doc-base/.manual.xml:1177769:22: error: element "tgroup" not allowed yet; expected element "caption", "info", "title" or "titleabbrev"

IMO we have to have both (section and table titles). It will be weird to have the title twice but less confusing than not have section title. WDYT ?

Please see Gina's suggestions. Changing the <table> element to an <informaltable> and removing the <title> that appears inside the <table> container works nicely, I think.

This is what I see locally when I render with the changes.
image

@sad270
Copy link
Author

sad270 commented Apr 7, 2025

It's done !
🙏🏻 Thanks @tiffany-taylor @Girgias for the help !

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