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.

Sign up for GitHub

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

Jump to bottom

Improvements to docstrings #673

Closed
felixcremer opened this issue Mar 19, 2024 · 12 comments
Closed

Improvements to docstrings #673

felixcremer opened this issue Mar 19, 2024 · 12 comments

Comments

@felixcremer
Copy link
Contributor

I am currently reading through the docstrings and will capture confusions and possible improvements here. Feel free to ignore for now.
@felixcremer

This comment was marked as outdated.

Sign in to view
@felixcremer

This comment was marked as outdated.

Sign in to view
@felixcremer

This comment was marked as outdated.

Sign in to view
@felixcremer
Copy link
Contributor Author

DimStackInterface should mention AbstractDimStack instead of Abstractdimarray

@felixcremer
Copy link
Contributor Author

DimTable example should show DimTable

@felixcremer
Copy link
Contributor Author

felixcremer commented Mar 23, 2024 •
edited
Loading

Dimensions docstring could mention exports and most common use cases. Maybe use parts of IDim docstring

@felixcremer
Copy link
Contributor Author

felixcremer commented Mar 23, 2024 •
edited
Loading

Clarify differences betwen DimPoints and DimIndices and DimKeys DimSelectors

@felixcremer
Copy link
Contributor Author

Clarify differences betwen DimPoints and DimIndices and DimKeys

@felixcremer

This comment was marked as outdated.

Sign in to view
@felixcremer
Copy link
Contributor Author

Does Near give a warning when out of bounds?

@rafaqz
Copy link
Owner

rafaqz commented Mar 23, 2024 •
edited
Loading

Near gets the nearest however far that is, so no.

@felixcremer
Copy link
Contributor Author

Should result in DimSelectors example be two dim not three dim?

@felixcremer felixcremer mentioned this issue Apr 21, 2024
Merged
@rafaqz rafaqz closed this as completed Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rafaqz @felixcremer