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 wrong argument name in README #294

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Fix wrong argument name in README #294

merged 1 commit into from
Nov 20, 2024

Conversation

jank324
Copy link
Member

@jank324 jank324 commented Nov 20, 2024

Description

The argument name for the incoming beam in Segment.plot_overview was changed from beam to incoming, but in a recent PR not updated in the README. This is what is done here.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Fixes #256. Is a continuation of #266.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code and checked that formatting passes (required).
  • I have have fixed all issues found by flake8 (required).
  • I have ensured that all pytest tests pass (required).
  • I have run pytest on a machine with a CUDA GPU and made sure all tests pass (required).
  • I have checked that the documentation builds (required).

Note: We are using a maximum length of 88 characters per line.

@jank324 jank324 self-assigned this Nov 20, 2024
@jank324 jank324 added the documentation Improvements or additions to documentation label Nov 20, 2024
@jank324 jank324 marked this pull request as ready for review November 20, 2024 16:52
@jank324 jank324 merged commit 46516f7 into master Nov 20, 2024
8 checks passed
@jank324 jank324 deleted the doc07fix2 branch November 20, 2024 16:53
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.

Update documentation for v0.7
1 participant