JuliaGPU / Metal.jl

Metal programming in Julia
MIT License
341 stars 36 forks source link

Missing public/exported docstrings #358

Open christiangnrd opened 1 month ago

christiangnrd commented 1 month ago

Found using Docs.undocumented_names from 1.11. They should also be added to the documentation when a docstring is created.

Metal

MTL

Important:

Other:

Unexport:

maleadt commented 1 month ago

I guess we should first focus on documenting Metal, before moving to MTL/MPS which aren't likely to be imported or even used by users directly. For these modules, the documentation would likely be a copy of Apple's documentation anyway (which is similarly why many of these aren't thoroughly documented in CUDA.jl).

A couple should also be unexported: SimpleVersion/@sv_str definitely, and AS probably too.