unimib-thesis-mad
/
reCTBN
1
0
Fork 0
Code Issues 9 Pull Requests 1 Releases Activity
Labels Milestones
New Issue

[Feature] Add a first wave of docstrings to core parts of the library #66

Closed
opened 2 years ago by meliurwen · 0 comments
meliurwen commented 2 years ago (Migrated from github.com)
Owner

Description

As a contributor, I want at least some relevant parts of the code documented, so it is easier to catch up when development is resumed after some time.

As a new contributor, I want at least some relevant parts of the code documented, so it is easier and quiucker to be on a par with other contributors and make relevant cotnributions.

As a user, I want at least some relevant parts of the code documented, so it is easier and quicker for me to learn how to use this library.

Acceptance Criteria

  • Relevant components documented

Checklist

  • Add docstrings to the crate level
  • Add docstrings to relevant components

(Optional) Extra info

None

## Description As a contributor, I want at least some relevant parts of the code documented, so it is easier to catch up when development is resumed after some time. As a new contributor, I want at least some relevant parts of the code documented, so it is easier and quiucker to be on a par with other contributors and make relevant cotnributions. As a user, I want at least some relevant parts of the code documented, so it is easier and quicker for me to learn how to use this library. ## Acceptance Criteria * Relevant components documented ## Checklist * [x] Add docstrings to the crate level * [x] Add docstrings to relevant components ## (Optional) Extra info None
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
62-feature-rectbnpy
72-feature-add-logging-and-documentation
88-feature-add-benchmarks
dev
main
Labels
Apply 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 help wanted
Extra help is needed invalid
This doesn't seem right meta
Something related to the project itself question
Further information is requested refactor
Change in the structure urgent wontfix
This will not be worked on
No Label bug documentation duplicate enhancement help wanted invalid meta question refactor urgent wontfix
Milestone
Set milestone
Clear milestone
No items
No Milestone
v0.1.0
Assignees
Assign users
Clear assignees
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

No dependencies set.

Reference: unimib-thesis-mad/reCTBN#66
Write Preview
Loading…
Cancel
Save
There is no content yet.
Delete Branch '%!s(<nil>)'

Deleting a branch is permanent. It CANNOT be undone. Continue?

No
Yes