rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity

[Setup] Documentation #10

Merged
javier merged 12 commits from setup/documentation into main 2023-04-23 13:16:23 +00:00
Conversation 0 Commits 12 Files Changed 14 +290 -70
javier commented 2023-04-23 13:15:10 +00:00
Owner
Copy Link

This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers.

To provide further details about the work done:

  • restructured the hierarchy of some models that are related to the Amiibo model;
  • written documentation for the AmiiboService service;
  • written documentation for the AmiiboFilter and KeyNameFilter filters;
  • written documentation for the Amiibo, KeyName, LastUpdated and children model;
  • written documentation for the AmiiboClientError error;
  • written documentation for the README file.
This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers. To provide further details about the work done: - [x] restructured the hierarchy of some models that are related to the `Amiibo` model; - [x] written documentation for the `AmiiboService` service; - [x] written documentation for the `AmiiboFilter` and `KeyNameFilter` filters; - [x] written documentation for the `Amiibo`, `KeyName`, `LastUpdated` and children model; - [x] written documentation for the `AmiiboClientError` error; - [x] written documentation for the README file.
javier added this to the First official release milestone 2023-04-23 13:15:10 +00:00
javier self-assigned this 2023-04-23 13:15:10 +00:00
javier added 12 commits 2023-04-23 13:15:11 +00:00
javier added a new dependency 2023-04-23 13:15:45 +00:00
#7 Document the library
javier removed a dependency 2023-04-23 13:16:12 +00:00
#7 Document the library
javier merged commit c4a25afad4 into main 2023-04-23 13:16:23 +00:00
javier deleted branch setup/documentation 2023-04-23 13:16:23 +00:00
javier referenced this issue from a commit 2023-04-23 13:16:23 +00:00
[Setup] Documentation (#10)
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
question
More information is needed
wontfix
This won't be fixed
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone First official release
Assignees
Clear assignees
No Assignees javier
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rock-n-code/amiibo-service#10
No description provided.
Delete Branch "setup/documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?