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

Synchronize list of predefined constants with stubs - part 6 #2771

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

Conversation

kocsismate
Copy link
Member

No description provided.

Copy link
Member

@Girgias Girgias left a comment

Choose a reason for hiding this comment

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

I wonder if doesn't make more sense to just convert these constant pages to use the more usual formatting? Do you know how many constant pages currently use tables and how many use the other markup?

@@ -17,149 +17,217 @@
</thead>
<tbody>
Copy link
Member

Choose a reason for hiding this comment

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

Would it be possible to also change the wording in the header row to use the relevant entities?

Also, this table looks inconsistent with the other table (and the availability row seems completely pointless here and could be removed).

@kocsismate
Copy link
Member Author

The following other predefined constant pages use the table-based approach:

(maybe there are a few more, but I could only find these after a quick search)

So all in all, conversion to the list based format is possible since there are not too many constant tables. IMO the only place where the table makes sense it the list of tokens...

@kocsismate
Copy link
Member Author

kocsismate commented Sep 25, 2023

On the other hand, if we wanted to migrate https://www.php.net/manual/en/function.curl-setopt.php to a predefined constant page then using the list based format is also questionable, using tables look more appropriate 🤔 . So I don't have a good answer whether we should really do the conversion to lists, since there are a very few exceptions.

@Girgias
Copy link
Member

Girgias commented Sep 26, 2023

On the other hand, if we wanted to migrate https://www.php.net/manual/en/function.curl-setopt.php to a predefined constant page then using the list based format is also questionable, using tables look more appropriate 🤔 . So I don't have a good answer whether we should really do the conversion to lists, since there are a very few exceptions.

The cURL setopt API is just badly designed that I have no idea how to reasonably document it.

But yes I don't know what is the best format for documenting them, the list based approach is good for long descriptions, the table one is good for an overview.

Maybe doing something like INI pages where there is first a table that gives an overview and availability and then below a a list of them with individual descriptions?

See https://www.php.net/manual/en/ini.core.php#ini.sect.language-options

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.

2 participants