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

perlguts: Fix apidoc lines #22304

Merged
merged 1 commit into from
Jun 23, 2024
Merged

perlguts: Fix apidoc lines #22304

merged 1 commit into from
Jun 23, 2024

Conversation

khwilliamson
Copy link
Contributor

The functions have different signatures, so can't be considered one group, due to the constraints of autodoc. This change causes perlintern.pod to now have the correct pod for the affected items.

The functions have different signatures, so can't be considered one
group, due to the constraints of autodoc.
@jkeenan
Copy link
Contributor

jkeenan commented Jun 21, 2024

The functions have different signatures, so can't be considered one group, due to the constraints of autodoc. This change causes perlintern.pod to now have the correct pod for the affected items.

In perl-5.40.0 and in blead, when I call perldoc perlintern and scroll down to the subsection on Concurrency, I see:

Concurrency
    "CVf_SLABBED"
    "CvROOT"
    "CvSTART"
        Described in perlguts.

    "CX_CUR"
        Described in perlguts.

              CX_CUR()
...

When I build your branch and do likewise, I see:

Concurrency
    "CVf_SLABBED"
        Described in perlguts.

    "CvROOT"
        Described in perlguts.

            OP *  CvROOT(CV * sv)

    "CvSTART"
        Described in perlguts.

            OP *  CvSTART(CV * sv)

    "CX_CUR"
        Described in perlguts.

              CX_CUR()

    "CXINC"
        Described in perlguts.

...

Is that what you are aiming for in this p.r.?

@khwilliamson
Copy link
Contributor Author

Yes, though a commit in the pipeline will cut down the textual expansion. The prototypes for all non-trivial calls have been traditionally displayed in perlapi and perlintern even when the details of what happens with those calls are given in another pod, as here, perlguts. I made that choice back when, perhaps without realizing it. But when I did, I left it that way, as this was a way to make sure they did get displayed at least somewhere. Someone coming here first will see them before going off to perlguts. Presumably this is the place to start.

What's happening in this case is that CVf_SLABBED has a trivial prototype -- just its name, so it is omitted. The other two have more complicated ones, so theirs should have been displayed, but weren't, because of the bug this commit fixes. Now, their prototypes do get displayed.

@khwilliamson khwilliamson merged commit 86b7de6 into Perl:blead Jun 23, 2024
30 checks passed
@khwilliamson khwilliamson deleted the cvroot branch June 23, 2024 13:00
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