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.

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

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

Closed
mattuntergassmair opened this issue Mar 1, 2020 · 1 comment

Comments

@mattuntergassmair
Copy link
Collaborator

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
Copy link
Member

I agree with this.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants