-
Notifications
You must be signed in to change notification settings - Fork 559
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
autodoc: Rework calculating the usage sections #22345
Conversation
Entries in perlapi and perlintern end with a usage section that give the calling prototype signatures of the items in the entry. This commit reworks the calculation of that. Future planned commits were running into limitations with the previous algorithm. This new one makes those commits easier, is hopefully clearer, and it turns out fixes some bugs where the signatures extended too far right in the verbatim blocks.
When I build first blead, and then your branch, and look at the respective
Is that what you were expecting? |
Yes. Entries are supposed to use only the first 78 columns. This is because we strive to avoid ugly wrapping in windows at least 80 characters wide, and common pagers (like If you look at the entries that are folded differently, the previous version occupied 79 columns The pod isn't supposed to include trivial prototype lines consisting solely of the name of the construct. The previous version wrongly included the EXTERN_C lines, therefore |
Entries in perlapi and perlintern end with a usage section that give the calling prototype signatures of the items in the entry. This commit reworks the calculation of that. Future planned commits were running into limitations with the previous algorithm. This new one makes those commits easier, is hopefully clearer, and it turns out fixes some bugs where the signatures extended too far right in the verbatim blocks.