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

Documentation improvements for Dataset #348

Open
kevinrsoursib opened this issue Nov 21, 2024 · 1 comment
Open

Documentation improvements for Dataset #348

kevinrsoursib opened this issue Nov 21, 2024 · 1 comment

Comments

@kevinrsoursib
Copy link

The documentation for the Dataset class is ambiguous and confusing. In particular it's hard to follow which functions return a reference to the current Dataset (like transform) after modification in place and which (like filter) make return a newly created dataset copying some or all of the current dataset. In particular the way the filter function is described implies modification in place which is not what it does.

@andrewdalpino
Copy link
Member

Hi @kevinrsoursib thanks for the feedback. Would you like to help clarify the documentation? I agree that the documentation could be clearer but because the project is so underfunded (it's basically just me funding it with my own time and money) we cannot actually make improvements without the help of the community such as yourself.

Thanks and feel free to reach out if I can help get you started.

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

No branches or pull requests

2 participants