Clarify rx parameter of compileall functions

[jeanas]

This includes nesting re.Pattern (and, while at it, re.Match) in
a class directive so it can be cross-referenced.

[the-knights-who-say-ni]

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@jean-abou-samra

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

[JelleZijlstra]

Looks good, thanks for your contribution! I didn't build the docs manually though to see how it looks.

[JulienPalard]

@jean-abou-samra don't forgot to sign the CLA.

The diff looks ugly, but it is correct, yet I'm not fully happy with the output, (and not fully happy with this kind of diff):

Match Objects

Match objects always have a boolean value of True. Since match() and search() return None when there is no match, you can test whether there was a match with a simple if statement:

    match = re.search(pattern, string)
    if match:
        process(match)

Match objects support the following methods and attributes:

class re.Match¶

    expand(template)

I mean, the "Match objects support the following methods and attributes:" looks wrong now that the following item is a class, not a list of methods and attributes.

@jean-abou-samra In order to fix this, and to have a cleaner diff, can you please link using:

 :ref:`re.Pattern <re-objects>`

instead of:

:class:`re.Pattern`

? This would completly avoid touching the re.rst file, changing a 450-lines diff to a 10 lines diff.

Bonne soirée.

[jeanas]

@JulienPalard I followed your suggestion and it should look cleaner now. (Also signed the CLA.)

The CI failure seems like an artifact of the renaming of the master branch yesterday. Let's see how it goes this time.

[JulienPalard]

LGTM

[miss-islington]

Thanks @jean-abou-samra for the PR, and @JulienPalard for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.9.
🐍🍒⛏🤖

[bedevere-bot]

@JulienPalard: Please replace # with GH- in the commit message next time. Thanks!

[JulienPalard]

(woops the GH- :D it's hard to ping-pong between repos with different rules ☹)

[bedevere-bot]

GH-25900 is a backport of this pull request to the 3.10 branch.

[bedevere-bot]

GH-25901 is a backport of this pull request to the 3.9 branch.