search

rafaqz / DimensionalData.jl

Named dimensions and indexing for julia arrays and other data
https://rafaqz.github.io/DimensionalData.jl/stable/
MIT License
262 stars 38 forks source link

Improvements to docstrings #673

Open felixcremer opened 3 months ago

felixcremer commented 3 months ago

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

felixcremer commented 3 months ago

Label keyword in Bins not documented

felixcremer commented 3 months ago

Label describtion in CyclicBins should be generic and not mentio months

felixcremer commented 3 months ago

Typos in DimStack docstring amd maching

felixcremer commented 3 months ago

DimStackInterface should mention AbstractDimStack instead of Abstractdimarray

felixcremer commented 3 months ago

DimTable example should show DimTable

felixcremer commented 3 months ago

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

felixcremer commented 3 months ago

Clarify differences betwen DimPoints and DimIndices and DimKeys DimSelectors

felixcremer commented 3 months ago

Clarify differences betwen DimPoints and DimIndices and DimKeys

felixcremer commented 3 months ago

Evne in LookupArrays docstring also mention exports

felixcremer commented 3 months ago

Does Near give a warning when out of bounds?

rafaqz commented 3 months ago

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

felixcremer commented 3 months ago

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