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

Advice docs are too verbose #134

Open
allan2 opened this issue Dec 13, 2024 · 1 comment
Open

Advice docs are too verbose #134

allan2 opened this issue Dec 13, 2024 · 1 comment

Comments

@allan2
Copy link
Collaborator

allan2 commented Dec 13, 2024

The docs in the advice module are long. They are mostly copied and pasted from the Linux man page.

Some current problems:

I propose limiting each value's comment to just a few lines. A brief explanation and a safety block when needed. The Advice enum's comment already includes a link to the man page, for those who need more explanation.

madvise is also not just for Linux. Other reference pages include FreeBSD and Mac OS X.

#133 affected

@de-vri-es
Copy link
Collaborator

Agreed. If we can simplify the text here and refer to external documentation for platform specific details, I think that's better.

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

2 participants