eminence / eminence/procfs

Improve our examples

Open
#290 0 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted
Dominant language
Rust
Stars
445
Forks
134
PR merge metrics
No merged PRs in 30d

Description

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

For example, the [`partitions.rs`](https://github.com/eminence/procfs/blob/71addc0766626dca44f5be3d771b204f6ed1fc3d/procfs/examples/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`](https://github.com/eminence/procfs/blob/71addc0766626dca44f5be3d771b204f6ed1fc3d/procfs/examples/interface_stats.rs) or [`lslocks.rs`](https://github.com/eminence/procfs/blob/71addc0766626dca44f5be3d771b204f6ed1fc3d/procfs/examples/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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.