Refactor code structure for readability and maintainability#32
Merged
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #32 +/- ##
=======================================
Coverage 80.62% 80.62%
=======================================
Files 41 41
Lines 5393 5393
=======================================
Hits 4348 4348
Misses 1045 1045 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation and example code for PlotNado, focusing on improving onboarding, clarifying workflows, and reorganizing the docs structure. The main changes include a major rewrite of the
README.mdto streamline installation and usage instructions, updates to the Quarto documentation navigation, and the addition of a new Python module for generating in-memory example data.Documentation and onboarding improvements:
README.md: Completely rewritten for clarity and ease of onboarding. The new README provides concise installation instructions, clearer separation between Python and CLI workflows, and emphasizes reproducible in-memory examples. It also updates feature lists, troubleshooting tips, and contribution guidelines. [1] [2] [3] [4]Documentation structure and navigation:
_quarto.yml: Refactored the navigation structure to improve the order and grouping of documentation sections, update descriptions, and clarify menu items. Some unused or redundant references were removed or renamed for clarity. [1] [2]Example and utility code:
docs/_examples.py: Added a new module containing utility functions for generating synthetic genomic signal, interval, and link data as pandas DataFrames. This module supports reproducible, in-memory examples for documentation and notebooks, and includes example figure-generating functions.