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

Doc improvement: add comment describing what convolve does #264

Conversation

metric-space
Copy link
Contributor

Description

This is a suggestion for doc improvement.
The use of convolution in average calculation (in the blackjack tutorial) doesn't jump out unless you've used the operation in the past. Felt a comment might aid someone else a bit lost as to why np.convolve is used

Type of change

  • This change requires a documentation update

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@pseudo-rnd-thoughts
Copy link
Member

Thanks for the PR and comment. You are correct that the current code is weird and isn't well explained but I think the comment can be significantly simpler and not explain how convolve works.
Could the comment just be next to the first case that says, "code ... is used to compute a rolling average of the data to provide a more smooth graph"

@metric-space
Copy link
Contributor Author

metric-space commented Jan 16, 2023

@pseudo-rnd-thoughts What you said makes more sense than what I had. Do I go ahead and put that line in or would you do that (in a separate PR and I can close this one )?

@pseudo-rnd-thoughts
Copy link
Member

@metric-space Im happy for you to use this PR

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit bb368fe into Farama-Foundation:main Jan 17, 2023
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.

2 participants