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

Minor Documentation Cleanup #1090

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Minor Documentation Cleanup #1090

wants to merge 13 commits into from

Conversation

philipc2
Copy link
Member

@philipc2 philipc2 commented Nov 27, 2024

Closes #1089 #1099

Overview

Cleans up docs, updates the Why UXarray page to highlight analysis operators, adds missing docstrings to intersection functions.

@philipc2 philipc2 self-assigned this Nov 27, 2024
@philipc2 philipc2 added the documentation Improvements or additions to documentation label Nov 27, 2024
@aaronzedwick aaronzedwick linked an issue Dec 6, 2024 that may be closed by this pull request
@aaronzedwick
Copy link
Member

@philipc2 is there anything else that should be done with this PR before it is merged?

@philipc2
Copy link
Member Author

@philipc2 is there anything else that should be done with this PR before it is merged?

Yeah, I have a few more additions I'm planning to make before setting it ready for review.

@philipc2
Copy link
Member Author

@aaronzedwick

If you'd like to make the README changes here, feel free to.

@philipc2
Copy link
Member Author

@aaronzedwick

Are there any other changes that we would like to make, or should we go ahead and get this ready to merge?

@aaronzedwick
Copy link
Member

@aaronzedwick

Are there any other changes that we would like to make, or should we go ahead and get this ready to merge?

Should be good to go.

@philipc2
Copy link
Member Author

@aaronzedwick

The additions are good, however it makes our README look very cluttered & it takes up a ton of space.

image

I'm going to iterate on these to condense them.

@philipc2 philipc2 changed the title DRAFT: Doc cleanup Minor Documentation Cleanup Jan 16, 2025
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.

Add docstrings to intersection functions Better Organize & Document Analysis Operators
2 participants