Skip to content

[idea] Merge constant aliases by using multiple term tags for a varlistentry#5516

Open
Girgias wants to merge 1 commit into
php:masterfrom
Girgias:alias-constant-markup-idea
Open

[idea] Merge constant aliases by using multiple term tags for a varlistentry#5516
Girgias wants to merge 1 commit into
php:masterfrom
Girgias:alias-constant-markup-idea

Conversation

@Girgias
Copy link
Copy Markdown
Member

@Girgias Girgias commented Apr 27, 2026

As a reply to #5434 (comment) I think improving the markup of aliased constants to something like this probably makes the most sense, as we don't duplicate wording nor need to specify X is an alias of Y. :)

@Girgias Girgias requested a review from kocsismate April 27, 2026 12:04
@jordikroon
Copy link
Copy Markdown
Member

From a reader perspective I am not sure if this is clear enough. Because the extra enter could also indicate that the first constant may not have a description. Even though if that were the case it would have had an extra enter.

Additionally Error reporting constants are also formatted this way, but they are not considered aliases.

My suggestion (this would keep them on the same line):

<varlistentry>
 <term>
  <constant xml:id="constant.zend-thread-safe">ZEND_THREAD_SAFE</constant>,
  <constant xml:id="constant.php-zts">PHP_ZTS</constant>
  (<type>bool</type>)
 </term>
 <listitem>
  <simpara>
   Indicates whether the current build of PHP is thread safe.
  </simpara>
 </listitem>
</varlistentry>

@Girgias
Copy link
Copy Markdown
Member Author

Girgias commented May 7, 2026

From a reader perspective I am not sure if this is clear enough. Because the extra enter could also indicate that the first constant may not have a description. Even though if that were the case it would have had an extra enter.

Additionally Error reporting constants are also formatted this way, but they are not considered aliases.

My suggestion (this would keep them on the same line):

<varlistentry>
 <term>
  <constant xml:id="constant.zend-thread-safe">ZEND_THREAD_SAFE</constant>,
  <constant xml:id="constant.php-zts">PHP_ZTS</constant>
  (<type>bool</type>)
 </term>
 <listitem>
  <simpara>
   Indicates whether the current build of PHP is thread safe.
  </simpara>
 </listitem>
</varlistentry>

Sorry for the late reply, that could also work and happy either way :)

@jordikroon
Copy link
Copy Markdown
Member

@kocsismate is this something you could try for #5434?

@kocsismate
Copy link
Copy Markdown
Member

@jordikroon Absolutely, that's what I would also prefer!

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