sisl / AutomotiveDrivingModels.jl

Driving simulation architecture for Julia
Other
63 stars 29 forks source link

Get rid of documentation warnings - make documentation work for interfaces #63

Closed mattuntergassmair closed 4 years ago

mattuntergassmair commented 4 years ago

Using julia --project make.jl prints several warnings for missing docstrings, for example for the get_name function. get_name is documented in the interface, but without argument signature. The documentation (such as in docs/src/behaviors.md) currently lists get_name(::DriverModel for documentation which creates a warning.

More generally, the goal should be to make the documentation-generation warning-free

MaximeBouton commented 4 years ago

I agree with this.

Regarding get_name specifically, it should be deprecated now so we can remove it from the doc.