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

Enhance readability and usability of demo_basic notebook #353

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

alexfazio
Copy link

Changes Made

This pull request improves the readability and usability of the demo_basic notebook. Specifically, I have:

  • Updated dependencies and IO naming consistency
  • Improved notebook structure and flow
  • Added more detailed comments and explanations
  • Enhanced markdown cells with clearer instructions

Details of Changes

  • Modified examples/demo_basic.ipynb
  • Added new markdown cells with explanatory text to guide users
  • Updated code cells with more descriptive variable names and additional comments
  • Ensured consistency in naming conventions throughout the notebook

Motivation

These changes aim to make our demo_basic notebook more accessible to new users and easier to follow. By improving clarity and structure, we hope to enhance the learning experience for those exploring our project and make it easier for contributors to understand our basic demonstration.

Testing

I have run all cells in the modified notebook to ensure they execute without errors. The outputs have been cleared to keep the PR diff clean.

Please review and let me know if any further changes or clarifications are needed.

- Raise minimum Python version to 3.9
- Move numpy to correct section in pyproject.toml
- Update numpy to ^1.25.0
- Resolve dependency conflicts
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

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.

1 participant