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.

Sign up for GitHub

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

Jump to bottom

Update scx_layered docs to match layer stats #701

Closed
hodgesds opened this issue Sep 26, 2024 · 4 comments
Closed

Update scx_layered docs to match layer stats #701

hodgesds opened this issue Sep 26, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@hodgesds
Copy link
Contributor

Update the documentation for layer stats to be in sync with the LayerStats struct, or even better yet automate the documentation.
@hodgesds hodgesds added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 26, 2024
@minosfuture
Copy link
Contributor

how about using StatsFieldAttrs::desc to generate #[doc = ...] in Stats macro?
and add a doc link like Global statistics: see [`SysStats`]

@hodgesds
Copy link
Contributor Author

how about using StatsFieldAttrs::desc to generate #[doc = ...] in Stats macro? and add a doc link like Global statistics: see [`SysStats`]

Awesome idea, can you send a pull request?

@minosfuture
Copy link
Contributor

Please review #703, thanks!

@hodgesds
Copy link
Contributor Author

Thanks @minosfuture for working on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hodgesds @minosfuture