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

Document frames, types and library #32

Open
Nukesor opened this issue Jan 17, 2025 · 0 comments
Open

Document frames, types and library #32

Nukesor opened this issue Jan 17, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@Nukesor
Copy link
Owner

Nukesor commented Jan 17, 2025

Most types are fairly complex and only used under specific circumstances.

For this library to be useful, it should reflect as much information from the official specification as possible. Otherwise users have to switch between the ieee 802.11 specs and this library back and forth.

A good start would be to simply document the structs and enums, this will already help a lot.
Documenting unclear enum variants and functions would be the next logical step.

However, any documentation PRs at all are very much welcome!

@Nukesor Nukesor added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 17, 2025
@Nukesor Nukesor changed the title Document types Document frames, types and library Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant