search

ropensci / vcr

Record and replay HTTP requests
https://docs.ropensci.org/vcr
Other
77 stars 12 forks source link

Vignette is out of sync with docs #260

Closed adamhsparks closed 1 year ago

adamhsparks commented 1 year ago

https://docs.ropensci.org/vcr/articles/configuration.html#serialize_with is out of sync with the docs:

serialize_with: (character) "yaml" or "json". Note that you can have multiple cassettes with the same name as long as they use different serializers; so if you only want one cassette for a given cassette name, make sure to not switch serializers, or clean up files you no longer need.

sckott commented 1 year ago

thanks @adamhsparks !

i'll get it fixed

sckott commented 1 year ago

@maelle do you know anything about this? it seems like the docs at docs.ropensci.org have the up to date version but somehow the docs for configuration are not up to date. I can't see if jeroen's builder is building the docs or not. is there supposed to be a webhook here for jeroen's builder, or does this pkg automatically get built there?

maelle commented 1 year ago

@sckott https://github.com/ropensci/vcr/blob/6da4637ff62d3b3696d32913e7652524cb97690a/man/rmdhunks/configuration-vignette.Rmd#L86 needs to be updated I think?

The commit status for ropensci-docs is green so all should be good on that side.

sckott commented 1 year ago

thanks @maelle ! i was only looking at the function docs, thanks for catching that. pushed, will check and see if the docs build is updatd soon

sckott commented 1 year ago

updated https://docs.ropensci.org/vcr/articles/configuration.html#serialize_with - look good @adamhsparks ?

adamhsparks commented 1 year ago

It’s in sync, but there’s a typo that I now see, "Which serializer to use. “yaml” or “json”. “, should probably be "Which serializer to use, “yaml” or “json”."

On 17 Jun 2023, at 5:16 am, Scott Chamberlain @.***> wrote:

updated https://docs.ropensci.org/vcr/articles/configuration.html#serialize_with - look good @adamhsparks https://github.com/adamhsparks ?

— Reply to this email directly, view it on GitHub https://github.com/ropensci/vcr/issues/260#issuecomment-1595327453, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAYMIATCNRKA7ZUV4GJTQM3XLTEJTANCNFSM6AAAAAAZEORIPM. You are receiving this because you were mentioned.

sckott commented 1 year ago

thanks, will fix