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.

Sign up for GitHub

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

Jump to bottom

docs: use the read function for iterating over events #290

Merged
merged 1 commit into from
Jan 1, 2024
Merged

docs: use the read function for iterating over events #290

merged 1 commit into from
Jan 1, 2024

Conversation

tremorris1999
Copy link
Contributor

Objective

  • Describe the objective or issue this PR addresses.
  • If you're fixing a specific issue, say "Fixes #X".

Just a quick correction on the documentation for documentation on ContactReportingPlugin. The docs here use the deprecated .iter() function from EventReader. I searched the content of the repo and it looks like this is the only time the deprecated function is called.

Solution

  • Describe the solution used to achieve the objective above.

Change .iter() to .read().

@Jondolf Jondolf added the C-Docs Improvements or additions to documentation label Dec 31, 2023
@Jondolf Jondolf merged commit d7f0e8a into Jondolf:main Jan 1, 2024
4 checks passed
@tremorris1999 tremorris1999 deleted the docs-fix branch January 1, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
C-Docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tremorris1999 @Jondolf