search

sisl / Records.jl

Containers for object lists over time
Other
2 stars 2 forks source link

Good Type Info #2

Open chelseas opened 6 years ago

chelseas commented 6 years ago

Hi,

When debugging, it would be helpful to have useful type documentation. Especially because Julia uses "naked" imports (unlike Python where you 'import numpy as np' and then 'np.matrixmultiply' (you know what package to look in for the matrixmultiply function)).

My problem: typeinfo

How can we make it such that when I type?Frame in a jupyter notebook/REPL, I get useful information instead of No documentation found ? Also why are the field names wrong? If you look at the definition of Frame in Records.jl the fields are entities and n :Records.jl/src/frames.jl

The fact that it tells me it was defined in Records is helpful, but more information would be useful. For example the sentence 'Frame is a wrapper type for Vector and the field n is the length of the field entities.

I also have this complaint of many of the types defined in AutomotiveDrivingModels.jl

MaximeBouton commented 6 years ago

The overall package is missing some documentation. Adding a docstring where Frame is defined would fix the problem.