fix: sort results lexicographically by labels in their order of appearance#3293
Merged
johanneskoester merged 2 commits intomainfrom Feb 14, 2025
Merged
fix: sort results lexicographically by labels in their order of appearance#3293johanneskoester merged 2 commits intomainfrom
johanneskoester merged 2 commits intomainfrom
Conversation
Contributor
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe changes update two components within the HTML reporter. In the Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant N as Navbar
participant VM as View Manager
U->>N: Clicks on breadcrumb
N->>N: Executes getResultBreadcrumb()
U->>N: Invokes returned breadcrumb function
N->>VM: Calls setView("menu", clear category and subcategory)
VM-->>N: Updates the UI view to menu mode
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
snakemake/report/html_reporter/template/components/abstract_results.js (1)
94-96: 🛠️ Refactor suggestionMove PropTypes declaration to class level.
PropTypes should be declared at the class level, not inside the
renderEntriesmethod. This improves code organization and prevents unnecessary re-declarations.Move the PropTypes declaration outside the method:
class AbstractResults extends React.Component { + static propTypes = { + app: PropTypes.object.isRequired, + }; + render() { // ... existing code ... } renderEntries() { - AbstractResults.propTypes = { - app: PropTypes.object.isRequired, - };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
snakemake/report/html_reporter/template/components/abstract_results.js(3 hunks)snakemake/report/html_reporter/template/components/navbar.js(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (30)
- GitHub Check: testing (10, 3.12)
- GitHub Check: testing (10, 3.11)
- GitHub Check: testing (9, 3.12)
- GitHub Check: testing (9, 3.11)
- GitHub Check: testing (8, 3.12)
- GitHub Check: testing (8, 3.11)
- GitHub Check: testing (7, 3.12)
- GitHub Check: testing (7, 3.11)
- GitHub Check: testing (6, 3.12)
- GitHub Check: testing (6, 3.11)
- GitHub Check: testing (5, 3.12)
- GitHub Check: testing (5, 3.11)
- GitHub Check: testing-windows (10)
- GitHub Check: testing (4, 3.12)
- GitHub Check: testing-windows (9)
- GitHub Check: testing-windows (8)
- GitHub Check: testing (4, 3.11)
- GitHub Check: testing-windows (7)
- GitHub Check: testing (3, 3.12)
- GitHub Check: testing-windows (6)
- GitHub Check: testing (3, 3.11)
- GitHub Check: testing-windows (5)
- GitHub Check: testing (2, 3.12)
- GitHub Check: testing-windows (4)
- GitHub Check: testing (2, 3.11)
- GitHub Check: testing-windows (3)
- GitHub Check: testing (1, 3.12)
- GitHub Check: testing-windows (2)
- GitHub Check: testing (1, 3.11)
- GitHub Check: testing-windows (1)
🔇 Additional comments (3)
snakemake/report/html_reporter/template/components/navbar.js (1)
208-209: LGTM! Improved navigation behavior.The changes enhance the user experience by adding proper navigation functionality to the "Results" breadcrumb, allowing users to return to the menu view. The implementation is clean and consistent with other breadcrumb methods.
snakemake/report/html_reporter/template/components/abstract_results.js (2)
103-121: Well-structured entry object creation!The mapping of results to entry objects is clean and handles both labelled and unlabelled cases appropriately. The key generation is suitable for React's list rendering requirements.
133-169: Clean and efficient entry rendering implementation!The rendering logic follows React best practices with proper key usage and maintains a clean table structure.
|
2 tasks
johanneskoester
pushed a commit
that referenced
this pull request
Feb 27, 2025
🤖 I have created a release *beep* *boop* --- ## [8.29.0](v8.28.0...v8.29.0) (2025-02-27) ### Features * provide mechanism to link between report items (snakemake.report_href, see docs) ([#3224](#3224)) ([a024e60](a024e60)) * toggles for binary labels in report ([#3296](#3296)) ([7690998](7690998)) ### Bug Fixes * add missing [@conda](https://github.com/conda) annotations ([#3298](#3298)) ([0b541cc](0b541cc)) * properly handle remote storage when waiting for pipes ([#3317](#3317)) ([9f7e092](9f7e092)) * provide proper error messages if output file preparation (pipe, mkdir) fails ([#3309](#3309)) ([77ef176](77ef176)) * record file extension (e.g. .tsv) in between workflow cache records in order to avoid that files of the wrong format are erroneously returned by the cache. This will lead to some cache misses. But avoiding errors induced by the previous behavior of ignoring file extensions when seeking for cache records is more important. ([#3314](#3314)) ([4912f00](4912f00)) * sort results lexicographically by labels in their order of appearance ([#3293](#3293)) ([a19a0ac](a19a0ac)) ### Documentation * update best practices ([7270eb3](7270eb3)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kjohnsen
pushed a commit
to kjohnsen/snakemake
that referenced
this pull request
Dec 15, 2025
…rance (snakemake#3293) <!--Add a description of your PR here--> ### QC <!-- Make sure that you can tick the boxes below. --> * [x] The PR contains a test case for the changes or the changes are already covered by an existing test case. * [x] The documentation (`docs/`) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - **Enhanced Results Display:** Results are now organized and sorted for clearer, more intuitive presentation. - **Improved Navigation:** Clicking the breadcrumb now takes you back to the main menu, streamlining the navigation experience. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
kjohnsen
pushed a commit
to kjohnsen/snakemake
that referenced
this pull request
Dec 15, 2025
🤖 I have created a release *beep* *boop* --- ## [8.29.0](snakemake/snakemake@v8.28.0...v8.29.0) (2025-02-27) ### Features * provide mechanism to link between report items (snakemake.report_href, see docs) ([snakemake#3224](snakemake#3224)) ([a024e60](snakemake@a024e60)) * toggles for binary labels in report ([snakemake#3296](snakemake#3296)) ([7690998](snakemake@7690998)) ### Bug Fixes * add missing [@conda](https://github.com/conda) annotations ([snakemake#3298](snakemake#3298)) ([0b541cc](snakemake@0b541cc)) * properly handle remote storage when waiting for pipes ([snakemake#3317](snakemake#3317)) ([9f7e092](snakemake@9f7e092)) * provide proper error messages if output file preparation (pipe, mkdir) fails ([snakemake#3309](snakemake#3309)) ([77ef176](snakemake@77ef176)) * record file extension (e.g. .tsv) in between workflow cache records in order to avoid that files of the wrong format are erroneously returned by the cache. This will lead to some cache misses. But avoiding errors induced by the previous behavior of ignoring file extensions when seeking for cache records is more important. ([snakemake#3314](snakemake#3314)) ([4912f00](snakemake@4912f00)) * sort results lexicographically by labels in their order of appearance ([snakemake#3293](snakemake#3293)) ([a19a0ac](snakemake@a19a0ac)) ### Documentation * update best practices ([7270eb3](snakemake@7270eb3)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2 tasks
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
1 participant
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.
QC
docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).Summary by CodeRabbit