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

Update documentation for v0.7 #256

Open
jank324 opened this issue Sep 23, 2024 · 2 comments · Fixed by #266
Open

Update documentation for v0.7 #256

jank324 opened this issue Sep 23, 2024 · 2 comments · Fixed by #266
Labels
documentation Improvements or additions to documentation

Comments

@jank324
Copy link
Member

jank324 commented Sep 23, 2024

Needs to be done for #165. Should update the README and the example notebooks. Can only be done after #213.

@jank324 jank324 added the documentation Improvements or additions to documentation label Sep 23, 2024
@jank324 jank324 mentioned this issue Sep 23, 2024
7 tasks
@jank324
Copy link
Member Author

jank324 commented Oct 1, 2024

#208 and #213 need to be merged before this can be fixed.

@jank324 jank324 linked a pull request Oct 3, 2024 that will close this issue
14 tasks
@cr-xu cr-xu closed this as completed in #266 Oct 7, 2024
@Hespe
Copy link
Member

Hespe commented Oct 7, 2024

I think the last line of the current README example is wrong. The argument has been renamed to incoming.

cheetah/README.md

Lines 86 to 88 in b9374ae

```python
segment.plot_overview(beam=beam)
```

@Hespe Hespe reopened this Oct 7, 2024
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 a pull request may close this issue.

2 participants