lubba64/game_inventory
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

Add more examples to the documentation. #6

New issue
Closed
opened 2022-07-17 21:34:58 +00:00 by Lubba-64 · 2 comments
Lubba-64 commented 2022-07-17 21:34:58 +00:00 (Migrated from github.com)
Copy link

There absolutely should be more examples for this crate in the documentation, or we should just move a bunch of the tests to docstrings. my only issue is that the tests can be kind of verbose because of all of the specific checks that have to be done, so I'm not super sure what the best way to approach this is.

There absolutely should be more examples for this crate in the documentation, or we should just move a bunch of the tests to docstrings. my only issue is that the tests can be kind of verbose because of all of the specific checks that have to be done, so I'm not super sure what the best way to approach this is.
maccesch commented 2022-07-23 14:59:57 +00:00 (Migrated from github.com)
Copy link

I think there should be examples in the readme as well. At least for basic usage.

I think there should be examples in the readme as well. At least for basic usage.
Lubba-64 commented 2022-07-23 15:01:25 +00:00 (Migrated from github.com)
Copy link

I think there should be examples in the readme as well. At least for basic usage.

Agreed, I can pretty easily include that in #8

> I think there should be examples in the readme as well. At least for basic usage. Agreed, I can pretty easily include that in #8
👍 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
Lubba-64-patch-1
arc
major-refactor
fix-naming-convention
refactor-inventory-managers
No results found.
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
lubba64/game_inventory#6
No description provided.