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

PEP 675: Mark malicious code example with red sidebar #3574

Merged
merged 3 commits into from
Dec 11, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 9, 2023

Fixes python/docs-community#22.

As suggested by @encukou in python/docs-community#22, the dangerous "naive" SQL code could do with a red marker.

image image

Regarding accessibility, similar to #3567, we're not relying on colour to convey meaning, it's also there in the text. ✅

Are there any examples in this PEP that could benefit from a red or green (or even yellow) sidebar? Perhaps the "written safely" one immediately after could be green?

Also remove the redundant headers.


📚 Documentation preview 📚: https://pep-previews--3574.org.readthedocs.build/

@hugovk hugovk requested a review from JelleZijlstra as a code owner December 9, 2023 16:42
@Rosuav
Copy link
Contributor

Rosuav commented Dec 9, 2023

Nice. This is a great feature to be able to roll out.

Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

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

@pradeep90 as an FYI

Copy link

cpython-cla-bot bot commented Dec 10, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@hugovk
Copy link
Member Author

hugovk commented Dec 10, 2023

Updated to include some more from @Jamim: hugovk#7

@Jamim Please could you sign the CLA? #3574 (comment)

Screenshots image image image image

@Jamim
Copy link
Contributor

Jamim commented Dec 10, 2023

Sure! I've signed the CLA.

@ambv ambv merged commit 8ce4ba9 into python:main Dec 11, 2023
6 checks passed
@hugovk hugovk deleted the pep675-mark-malicious branch December 12, 2023 05:28
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.

Roles/styles for good/bad code blocks in PEPs
5 participants