cpython icon indicating copy to clipboard operation
cpython copied to clipboard

gh-138633: indicate SSL backend requirements for SSL functions

Open picnixz opened this issue 5 months ago • 8 comments

If we are going to support multiple flavors of libssl, we should also plan to ease our life in the future when we want to say "this is ok for this flavor" so I added a Sphinx extension (actually it's similar to the availability directive but I decided to have a separate directive as it's not really the same; since the code would be the same, I just made a base directive class for that)

  • Issue: gh-138633

📚 Documentation preview 📚: https://cpython-previews--138656.org.readthedocs.build/

picnixz avatar Sep 08 '25 13:09 picnixz

@AA-Turner Do you mind reviewing this? or are you against a new extension (actually, do we encourage new Sphinx extensions or should we limit them?)

picnixz avatar Sep 10 '25 08:09 picnixz

@AA-Turner I've removed the new directive as discussed. Please have a look for the rewording of the availability definition.

picnixz avatar Sep 16 '25 09:09 picnixz

Ah I need to update the allow list of words.

picnixz avatar Sep 16 '25 09:09 picnixz

Friendly ping @AA-Turner

picnixz avatar Sep 29 '25 10:09 picnixz

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

bedevere-app[bot] avatar Sep 29 '25 13:09 bedevere-app[bot]

I think I found a compromise. I tried to be as generic as possible in the introduction for the availability note, and a bit more precise in the SSL document itself.

I have made the requested changes; please review again.

picnixz avatar Sep 30 '25 10:09 picnixz

Thanks for making the requested changes!

@AA-Turner: please review the changes made to this pull request.

bedevere-app[bot] avatar Sep 30 '25 10:09 bedevere-app[bot]

@AA-Turner friendly ping

picnixz avatar Jan 04 '26 14:01 picnixz