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

Improve documentation for BinrwNamedArgs #76

Closed
jam1garner opened this issue Oct 23, 2021 · 1 comment
Closed

Improve documentation for BinrwNamedArgs #76

jam1garner opened this issue Oct 23, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jam1garner
Copy link
Owner

Similar to #75, errors relating to improperly passing arguments can be confusing to binrw beginners due to the fact all the named types currently have no/minimal documentation. The goal of such a documentation improvement would be to help give users the information needed to solve errors that would reference the trait.
@jam1garner jam1garner added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 23, 2021
csnover added a commit to csnover/binrw that referenced this issue Aug 29, 2022
@csnover
Improve docs for BinrwNamedArgs
4a4cd28 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Aug 30, 2022
@csnover
Improve docs for BinrwNamedArgs
71c20ad 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Aug 30, 2022
@csnover
Improve docs for BinrwNamedArgs
99bbd03 
Refs jam1garner#76.
csnover added a commit that referenced this issue Aug 30, 2022
@csnover
Improve docs for BinrwNamedArgs
9e0d8b0 
Refs #76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
1929a6f 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
22b9b53 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
af27e0c 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
1e844df 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
d581a96 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
718f675 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 4, 2022
@csnover
Fix misleading errors on args directives
4a20ab0 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 6, 2022
@csnover
Fix misleading errors on args directives
1c82272 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 11, 2022
@csnover
Fix misleading errors on args directives
acaa9a1 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 11, 2022
@csnover
Improve hints in error reporting around required arguments
24022de 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 11, 2022
@csnover
Improve hints in error reporting around required arguments
2d60e0d 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 11, 2022
@csnover
Improve hints in error reporting around required arguments
1705152 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 11, 2022
@csnover
Improve hints in error reporting around required arguments
a3d090f 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 12, 2022
@csnover
Add usage documentation for NamedArgs macro
cae0775 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 12, 2022
@csnover
Improve hints in error reporting around required arguments
3ec8113 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 12, 2022
@csnover
Add usage documentation for NamedArgs macro
305ba41 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 12, 2022
@csnover
Improve hints in error reporting around required arguments
9e06cfb 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 12, 2022
@csnover
Add usage documentation for NamedArgs macro
ca3228b 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 14, 2022
@csnover
Improve hints in error reporting around required arguments
e95b83e 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 14, 2022
@csnover
Add usage documentation for NamedArgs macro
a4fccbf 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 18, 2022
@csnover
Improve hints in error reporting around required arguments
d6239fb 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Sep 18, 2022
@csnover
Add usage documentation for NamedArgs macro
1cb2eea 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 13, 2022
@csnover
Improve hints in error reporting around required arguments
991101d 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 13, 2022
@csnover
Add usage documentation for NamedArgs macro
9005cab 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 13, 2022
@csnover
Improve hints in error reporting around required arguments
11a5f45 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 13, 2022
@csnover
Add usage documentation for NamedArgs macro
881e38e 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 14, 2022
@csnover
Improve hints in error reporting around required arguments
2883190 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 14, 2022
@csnover
Add usage documentation for NamedArgs macro
177f355 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Improve hints in error reporting around required arguments
aed1a7c 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
733d6f5 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
bd2bddb 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Improve hints in error reporting around required arguments
8d47361 
Refs jam1garner#67, jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
cb32513 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
f374cfc 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
8f7d808 
Refs jam1garner#76.
csnover added a commit to csnover/binrw that referenced this issue Nov 15, 2022
@csnover
Add usage documentation for NamedArgs macro
037909d 
Refs jam1garner#76.
@csnover
Copy link
Collaborator

csnover commented Sep 22, 2023

Since I did apparently did some work on this sometime I will assume it is good enough for now.

@csnover csnover closed this as completed Sep 22, 2023
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
Projects
No open projects
binrw 0.9.0
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@csnover @jam1garner