Attempt to follow the Julia docstring conventions

JuliaInterop / Clang.jl

C binding generator and Julia interface to libclang

https://juliainterop.github.io/Clang.jl/

MIT License

222 stars 68 forks source link

Closed JamesWrigley closed 8 months ago

JamesWrigley commented 8 months ago

In particular, the docs recommends # Arguments instead of ### Parameters: https://docs.julialang.org/en/v1/manual/documentation/#Writing-Documentation

They also use a single '#' for other section headings, though in practice Documenter.jl seems to render them exactly the same anyway.

JamesWrigley commented 8 months ago

Ah, I see nightly tests are broken because of #464 :thinking: