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 proofr.Rmd #21

Merged
merged 4 commits into from
Aug 5, 2024
Merged

Update proofr.Rmd #21

merged 4 commits into from
Aug 5, 2024

Conversation

vortexing
Copy link
Member

wee tweak of the vignette

@@ -18,7 +18,7 @@ library(proofr)

## Authenticate with the PROOF API

Run the function `proof_authenticate()`, which calls the PROOF API with your username and password, and returns an API token (an alphanumeric string).
Run the function `proof_authenticate()`, which calls the PROOF API with your username and password, and returns an API token (an alphanumeric string). A new token is created when a new PROOF server is created, thus this API token will need to be reset.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not what happens. The token does not change. We can/should discuss whether it should, but currently it does not.

Copy link
Member

Choose a reason for hiding this comment

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

@vortexing can you undo this text change, or change the wording to explain that the same token is returned when calling proof_authenticate

@sckott
Copy link
Member

sckott commented Jul 8, 2024

@vortexing So maybe this isn't super clear (I'll make it more clear), but the original file that the vignette comes from is the file proofr.Rmd.og, and running make vign_getting_started creates proofr.Rmd. Okay if I port your changes on the .Rmd file into .Rmd.og file and remake .Rmd?

@tefirman
Copy link
Member

tefirman commented Aug 5, 2024

@sckott @dtenenba -- I removed the token sentence talked about above, ported the changes over to "proofr.md.og", and remade "proofr.md" using make vign_getting_started. Does this look okay now?

@sckott
Copy link
Member

sckott commented Aug 5, 2024

Thanks @tefirman ! looks good

@sckott sckott merged commit fda4cbb into main Aug 5, 2024
8 checks passed
@sckott sckott deleted the vortexing-patch-1 branch August 5, 2024 18:01
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.

4 participants