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

Fix argument name in cfr_time_varying() documentation #134

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Conversation

joshwlambert
Copy link
Member

@joshwlambert joshwlambert commented Apr 10, 2024

This PR fixes a possible typo in the documentation of cfr_time_varying() which references what is maybe a previous version of the delay_density argument, epidist.

  • I have read the CONTRIBUTING guidelines
  • A new item has been added to NEWS.md
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Checks have been run locally and pass

This PR doesn't not contain any (functional) user-facing or breaking changes.

@joshwlambert joshwlambert added the documentation Improvements or additions to documentation label Apr 10, 2024
@pratikunterwegs pratikunterwegs self-requested a review April 10, 2024 13:19
Copy link
Collaborator

@pratikunterwegs pratikunterwegs left a comment

Choose a reason for hiding this comment

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

Thanks for catching this @joshwlambert. I've just corrected another typo (my own), and rephrased the explanation of the delay distribution which I think makes it clearer. Feel free to merge it once the fix is added and checks pass.

R/cfr_time_varying.R Outdated Show resolved Hide resolved
@joshwlambert joshwlambert changed the title Fixed argument name in cfr_time_varying() documentation Fix argument name in cfr_time_varying() documentation Apr 11, 2024
@pratikunterwegs
Copy link
Collaborator

Just nudging @joshwlambert on this.

joshwlambert and others added 2 commits April 16, 2024 10:16
@joshwlambert
Copy link
Member Author

Thanks for the nudge @pratikunterwegs (or should I say Richard Thaler).

I've made a small change to the doc as mentioned in the message above, and now all the checks pass so I'll merge this PR.

@joshwlambert joshwlambert merged commit a8242f4 into main Apr 16, 2024
9 checks passed
@joshwlambert joshwlambert deleted the doc_fix branch April 16, 2024 09:38
@pratikunterwegs
Copy link
Collaborator

Thanks @joshwlambert! Although I will point out that behavioural economics is somewhat on the ropes these days :)

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.

3 participants