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

Improve our examples #290

Open
eminence opened this issue Oct 29, 2023 · 0 comments
Open

Improve our examples #290

eminence opened this issue Oct 29, 2023 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@eminence
Copy link
Owner

We have several examples in the procfs/examples folder. Some of them could use additional love and attention.

For example, the partitions.rs example doesn't do anything besides print out the Debug impl.

I've love if some of these examples were enhanced to be a little more polished.

This might mean printing fields in a nice table (like interface_stats.rs or lslocks.rs), or doing something a little more involved (like lslocks.rs) that shows a semi-realworld example of how you might use these functions.

Note that there is a balancing act here -- we don't want these examples to be too complicated, because they ought to be short, readable, and primarily about one feature in particular.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant