DimensionalData.jl Improvements to docstrings

Improvements to docstrings

Open felixcremer opened this issue 1 year ago • 12 comments

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

Mar 19 '24 22:03 felixcremer

Label keyword in Bins not documented

Mar 19 '24 22:03 felixcremer

Label describtion in CyclicBins should be generic and not mentio months

Mar 21 '24 07:03 felixcremer

Typos in DimStack docstring amd maching

Mar 22 '24 22:03 felixcremer

DimStackInterface should mention AbstractDimStack instead of Abstractdimarray

Mar 22 '24 22:03 felixcremer

DimTable example should show DimTable

Mar 23 '24 05:03 felixcremer

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

Mar 23 '24 12:03 felixcremer

Clarify differences betwen DimPoints and DimIndices and DimKeys DimSelectors

Mar 23 '24 12:03 felixcremer

Clarify differences betwen DimPoints and DimIndices and DimKeys

Mar 23 '24 23:03 felixcremer

Evne in LookupArrays docstring also mention exports

Mar 23 '24 23:03 felixcremer

Does Near give a warning when out of bounds?

Mar 23 '24 23:03 felixcremer

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

Mar 23 '24 23:03 rafaqz

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

Mar 27 '24 23:03 felixcremer