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

Update instructions for generate() in usage.md #26

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mattstibbs
Copy link

Add additional guidance around generation of live numbers vs synthetic numbers.

Add additional guidance around generation of live numbers vs synthetic numbers.
@andylaw
Copy link
Collaborator

andylaw commented Jun 14, 2023

Thanks @mattstibbs - this is good.

There's a typo in the word "synthetic" on line 79, and can I suggest that the warning probably needs to be (a) more stark and (b) reference the potential for using LIVE numbers rather than synthetic ones. Something like:

!!! WARNING: Careless use of numbers generated from this library could result in data loss,
damage or compromise. Under no circumstances should these be used in queries against
live health service systems.

Would you be happy with that phrasing?

@mattstibbs
Copy link
Author

Thanks for spotting the typo.

Agree we could make warning more stark, but I think it needs to be more explicit about how the risk can occur. I'll submit some revised phrasing.

@mattstibbs mattstibbs marked this pull request as draft June 14, 2023 11:34
@pacharanero
Copy link
Contributor

Any update on this draft PR @mattstibbs? Note that documentation has had other updates in the interim period so please check your updates are still playing well with the current code.

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.

3 participants