-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority:lowLow priorityLow priority
Description
Feature description
There are some methods in Cool-Seq-Tool that contain complex logic that may be challenging for a new user or contributor to understand. We should ensure in these methods that the documentation is thorough for these areas.
Use case
A new user may want to contribute to the codebase, but may not be able to accurately interpret function logic if the documentation is unclear.
Acceptance Criteria
The documentation for complex methods has been double-checked and expanded, when necessary. I plan to focus these efforts on functions that I wrote, in particular in the exon_genomic_coords.py module.
Proposed solution
No response
Potential Impact
No response
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority:lowLow priorityLow priority