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

fixes demo file usage with latest syntax #33

Merged
merged 3 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Copy link
Member

Choose a reason for hiding this comment

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

This might lead to merge conflicts with the other PR, hopefully not.

Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,4 @@ dmypy.json

# Pyre type checker
.pyre/
.idea/
8 changes: 8 additions & 0 deletions .idea/.gitignore
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess they are not necessary per se, but it was annoying to manually remove these files with every commit. But might be easier to switch to just ignoring .idea

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ any responsibility as a result of using this plugin.
Basic usage for our built-in titanic dataset is as follows:

```py
from metasyn import MetaFrame, demo_data
from metasyn import MetaFrame, demo_dataframe
from metasyncontrib.disclosure import DisclosurePrivacy
from metasyncontrib.disclosure.faker import DisclosureFaker
from metasyncontrib.disclosure.string import DisclosureFaker

df = demo_data("titanic")
df = demo_dataframe("titanic")

spec = [
{"name": "PassengerId", "distribution": {"unique": True}},
Expand Down