-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Description
Looking at some of the more recent changes and found that a lot of stuff is documented somewhere but not always in a discoverable way. For example, the doc string for AtomicMemory mentions the following without any of them being directly documented.
Core.CPUgetindex_atomicsetindex_atomic!setindexonce_atomic!swapindex_atomic!modfiyindex_atomic!replaceindex_atomic!
Since these all inevitably make it into a public interface and are mentioned in doc strings it would make sense for them to have their own doc strings and be marked as public.
For Core.CPU the explanation in GenericMemory's doc string seems sufficient. With some digging you can find some extra info in the atomic related macros for the others, but I'm not sure if there's a more complete interface outside of the documented macros.
Edit: I've reported some other missing docs recently with the advent of public but I continue to find them semiregularly (just remembered Base.RefValue). Would it be more efficient to have an issue pinned with a list of internals discussed for being made public and documented? Then these could be linked to relevant PRs and issues. This would make contributing on this front a lot easier.