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

User Guide for Tree Structures #806

Merged
merged 8 commits into from
Jun 25, 2024
Merged

User Guide for Tree Structures #806

merged 8 commits into from
Jun 25, 2024

Conversation

aaronzedwick
Copy link
Member

@aaronzedwick aaronzedwick commented May 30, 2024

Closes #804

Overview

Adds a user guide for the tree structures, BallTree and KDTree.

PR Checklist

General

  • An issue is linked created and linked
  • Add appropriate labels
  • Filled out Overview and Expected Usage (if applicable) sections

Examples

  • Any new notebook examples added to docs/examples/ folder
  • Clear the output of all cells before committing
  • New notebook files added to docs/examples.rst toctree
  • New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

@aaronzedwick aaronzedwick added the documentation Improvements or additions to documentation label May 30, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@philipc2 philipc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May you add the tree_structures.ipynb notebook to userguide.rst

.. toctree::
:maxdepth: 1
user-guide/terminology.rst
user-guide/representation.rst
user-guide/grid-formats.rst
user-guide/data-structures.ipynb
user-guide/area_calc.ipynb

@aaronzedwick aaronzedwick removed the documentation Improvements or additions to documentation label Jun 3, 2024
@rajeeja
Copy link
Contributor

rajeeja commented Jun 19, 2024

@philipc2 how about icons for users guide notebooks?

@aaronzedwick
Copy link
Member Author

@philipc2 how about icons for users guide notebooks?

I asked him about that, he said he doesn't think we need them for the user guides.

Copy link
Member

@philipc2 philipc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notebook looks perfect!

@philipc2 philipc2 merged commit e626119 into main Jun 25, 2024
15 checks passed
@aaronzedwick aaronzedwick deleted the zedwick/tree_user_guide branch June 26, 2024 20:19
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.

User Guide Section on KDTree and BallTree Data Structures
3 participants