Skip to content

added anonymization cheatsheet summary to improve documentation #182

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

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

Conversation

tuck183
Copy link

@tuck183 tuck183 commented Jun 20, 2025

This MR aims to improve the documentation for the pynonymizer tool by providing a cheat sheet. The cheat sheet contains quick strategy and patterns for anonymization.

@rwnx
Copy link
Owner

rwnx commented Jul 1, 2025

Thanks for the PR. I like the idea of a cheat sheet, but I have some concerns about the implementation:
The main issue is that this duplicates a lot of content from Faker's documentation. We intentionally rely on their docs rather than maintaining our own copies of strategy explanations - it's less maintenance overhead and avoids version drift.

This also covers similar ground to the existing README. Instead of having two intro documents, would it make more sense to either improve the main README or replace it entirely with this approach?

I'm also not sure how to predict which examples will actually be useful for most users. Everyone's anonymization needs are pretty different.

What if we focused this on pynonymizer-specific workflows and patterns, and kept references to Faker docs for the strategy details? That way we're adding value rather than duplicating existing documentation.

@tuck183
Copy link
Author

tuck183 commented Jul 9, 2025

Yes, this makes sense. I'll revisit this MR and apply changes as requested

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