Skip to content

Lacking Documentation #229

@HVinther

Description

@HVinther

While QML and QMLMakie generaly have a lot of examples, many functions remain undocumented. On the Julia side of QML 49% of the exported symbols lack a docstring.

using QML
length(Docs.undocumented_names(QML))/ length(names(QML))

0.4915254237288136

QMLMakie seems to be entirely undocumented, with https://juliagraphics.github.io/QML.jl/dev/#Makie-support simply stating that QMLMakie adds Makiesupport. The lineplot example on https://github.com/JuliaGraphics/QMLMakie.jl differs in the README.md and the examples/lineplot.jl in that one uses MakieViewport and the other MakieArea, but the difference between theses are not explained. One also uses QML.setGraphicsApi(QML.OpenGL) while the other does not. Again, this is undocumented.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions