ash
ash copied to clipboard
Safety docs on functions
It would be nice if the generator pasted the Valid Usage and Valid Usage (Implicit) sections of the registry into a safety doc.
Interesting idea. I'm not sure that would be terribly useful without the rest of the documentation to provide context, though.
I mean, the valid usage sections sort of stand on their own. The only concern I see is Enumerate* functions, because they have different parameters from what the registry says.
I mainly want this because I do a lot of my dev work offline, and I rely on offline docs a lot to do so, but using ash I need to get back online and load the registry page for a given function just to see the safety requirements.
I would've loved to automatically embed the (transformed) documentation in this crate, perhaps it is a possibility with the new composable generator that is being written.