Skip to content

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

Merged
ambv merged 3 commits into
python:mainfrom
hugovk:pep675-mark-malicious
Dec 11, 2023
Merged

PEP 675: Mark malicious code example with red sidebar#3574
ambv merged 3 commits into
python:mainfrom
hugovk:pep675-mark-malicious

Conversation

@hugovk

@hugovkhugovk commented Dec 9, 2023

Copy link
Copy Markdown
Member

Fixespython/docs-community#22.

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

imageimage

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/

@Rosuav

Copy link
Copy Markdown
Contributor

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

@JelleZijlstraJelleZijlstra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@pradeep90 as an FYI

@ghost

ghost commented Dec 10, 2023

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@hugovk

Copy link
Copy Markdown
MemberAuthor

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

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

Screenshotsimageimageimageimage

@Jamim

Copy link
Copy Markdown
Contributor

Sure! I've signed the CLA.

@ambv
ambv merged commit 8ce4ba9 into python:mainDec 11, 2023
@hugovk
hugovk deleted the pep675-mark-malicious branch December 12, 2023 05:28
Sign up for freeto 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

@hugovk@Rosuav@Jamim@JelleZijlstra@ambv