Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Safety docs on functions #925

Open
lylythechosenone opened this issue Jul 8, 2024 · 3 comments
Open

Safety docs on functions #925

lylythechosenone opened this issue Jul 8, 2024 · 3 comments

Comments

@lylythechosenone
Copy link

It would be nice if the generator pasted the Valid Usage and Valid Usage (Implicit) sections of the registry into a safety doc.

@Ralith
Copy link
Collaborator

Ralith commented Jul 9, 2024

Interesting idea. I'm not sure that would be terribly useful without the rest of the documentation to provide context, though.

@lylythechosenone
Copy link
Author

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.

@MarijnS95
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants