Skip to content

Python client: How to sanitise personalisation in send_email request#335

Open
CrystalPea wants to merge 2 commits into
mainfrom
sanitise-personalisation-python
Open

Python client: How to sanitise personalisation in send_email request#335
CrystalPea wants to merge 2 commits into
mainfrom
sanitise-personalisation-python

Conversation

@CrystalPea
Copy link
Copy Markdown
Contributor

Following the pattern from rest API docs.

Here is a screenshot of how the guidance will look on the page:

Screenshot 2026-05-26 at 12 43 43

Comment thread source/python.html.md.erb Outdated
Comment thread source/python.html.md.erb Outdated
Comment thread source/python.html.md.erb
Comment thread source/python.html.md.erb Outdated
Comment thread source/python.html.md.erb
Comment on lines +372 to +373
# email will appear as:
Anne Example, now [click this evil link]()
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.

This should be outside the code block (in a blockquote) because it’s not code

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

we had it like that at the beginning, it looked harder to read. Looks like you have quite a few comments regarding content as such - this PR is just one of several PRs implementing the content that was previously reviewed (three of those have already been merged).

Feels like if we want to change the content, it would be good to do it in a separate PR in all docs where it's been implemented, so we maintain consistency?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

(although I already committed the more minor changes)

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.

Do you have a link to that discussion/draft?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah the draft is here - not sure if google docs show discussion history: https://docs.google.com/document/d/1kehXL5m3LTJeqAmnlxW3C8Z-D2VBuI4QgvQD5oJ7pOM/edit?usp=sharing

To be fair the review happened back in the winter.

But yeah - for bigger changes, I'd say lets have a chat there, and if we decide to pursue them, lets implement in all docs at once?

And then this PR could be merged ahead of that discussion, so it could accompany the Python client changes.

The same will have to be done for restAPI, ruby and node docs.

Co-authored-by: Chris Hill-Scott <me@quis.cc>
@CrystalPea CrystalPea force-pushed the sanitise-personalisation-python branch from 6e869ce to be9924e Compare May 26, 2026 14:13
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