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

Edit introduction page based on doc session feedback #258

Merged
merged 16 commits into from
Aug 25, 2023

Conversation

pletale
Copy link
Collaborator

@pletale pletale commented Aug 18, 2023

Title: Edit introduction page based on doc session feedback

Description

  • Category: documentation
  • JIRA issue: SSCI-1472

Testing

@pletale pletale added the documentation Improvements or additions to documentation label Aug 18, 2023
@pletale pletale requested review from zmbc and a team as code owners August 18, 2023 20:18
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
simulating decennial censuses, surveys, taxes, and other administrative data).
By creating realistic, but simulated, data which includes these attributes, we
can make ER research and development easier for ourselves and others.
Vivarium_ to incorporate real, publicly accessible data about the US population.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I still think this "incorporate" makes it sound kind of sketchy, like it's hiding in the psp output somewhere.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
Vivarium_ to incorporate real, publicly accessible data about the US population.
Vivarium_ to imitate real, publicly accessible data about the US population.

How about this?

Copy link
Contributor

@NathanielBlairStahn NathanielBlairStahn Aug 18, 2023

Choose a reason for hiding this comment

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

I still think this "incorporate" makes it sound kind of sketchy, like it's hiding in the psp output somewhere.

What's wrong with incorporating "real, publicly accessible data"? That doesn't sound sketchy to me. I don't think we are imitating real, publicly accessible data; I think we are using real data to imitate/simulate the US population.

Copy link
Contributor

Choose a reason for hiding this comment

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

But I do think maybe we should elaborate what we mean by this if we're going to say it. Or maybe we should just say something else.

Copy link
Collaborator

Choose a reason for hiding this comment

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

re: "sketchy," it just sounds a bit ambiguous what we actually did with that real data, and how it relates to the simulated data. The publicly accessible part should alleviate concerns, but I'm not sure it completely would.

I agree about making this clearer!

pletale and others added 2 commits August 18, 2023 14:28
Co-authored-by: Zeb Burke-Conte <[email protected]>
Co-authored-by: Zeb Burke-Conte <[email protected]>
docs/source/index.rst Outdated Show resolved Hide resolved
simulating decennial censuses, surveys, taxes, and other administrative data).
By creating realistic, but simulated, data which includes these attributes, we
can make ER research and development easier for ourselves and others.
Vivarium_ to incorporate real, publicly accessible data about the US population.
Copy link
Collaborator

Choose a reason for hiding this comment

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

re: "sketchy," it just sounds a bit ambiguous what we actually did with that real data, and how it relates to the simulated data. The publicly accessible part should alleviate concerns, but I'm not sure it completely would.

I agree about making this clearer!

@pletale
Copy link
Collaborator Author

pletale commented Aug 22, 2023

I just tweaked some wording, maybe it's more clear now? Let me know what you think!

docs/source/index.rst Outdated Show resolved Hide resolved
is excited to introduce pseudopeople, the Python package that simplifies Entity Resolution (ER) research and
development. This package generates large-scale, simulated population data according to specifications by the user,
to replicate a range of complexities found in real applications of probabilistic record linkage software.
With sensitive data often required for ER, accessing and testing new methods and software has been a challenge -
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
With sensitive data often required for ER, accessing and testing new methods and software has been a challenge -
With sensitive data often required for ER, accessing and testing new methods and software has been a challenge ---

This should really be an em dash instead of a hyphen.

Copy link
Contributor

Choose a reason for hiding this comment

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

But see this other suggestion as well.

@pletale pletale merged commit dd96b14 into develop Aug 25, 2023
@pletale pletale deleted the introduction_page_edits branch August 25, 2023 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants