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

docs: fix anonymise_<field_name> example in usage docs #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kevinmarsh
Copy link

I noticed the example in the usage docs doesn't match the privacy meta docs says:

2024-08-13_07-20

``anonymise_<field_name>(self, instance)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Custom function to anonymise the named field, for when the standard anonymisers
won't produce the desired result. This should also be used for custom field
types.
Field name must appear in the ``fields`` list.
It should not return a value; instead it should operate directly on the
instance.

This should align with the privacy meta docs which say:

> It should not return a value; instead it should operate directly on the instance
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.

1 participant