coderabbitai[bot]
commented
1 month ago [!NOTE]
Reviews paused
Use the following commands to manage reviews:
@coderabbitai resumeto resume automatic reviews.@coderabbitai reviewto trigger a single review.
Walkthrough
The updates introduce several enhancements and new functionalities across multiple R scripts, focusing on file navigation, Roxygen tag parsing, and outline generation in RStudio. Key changes include adding functions for navigating active documents, refining Roxygen comment handling, improving outline criteria, and updating the logic for file renaming and screenshot functionalities. These updates aim to bolster interactive sessions, streamline project management, and enhance user feedback during document processing.
Changes
| File(s) | Change Summary |
|---|---|
R/open.R |
Added active_rs_doc_nav function for navigating active files in RStudio's Files Pane. |
R/outline-criteria.R |
Enhanced define_outline_criteria and o_is_roxygen_comment for better notebook and Roxygen handling. |
R/outline.R |
Renamed variables, added error handling, and refined logic for outline generation and display. |
R/screenshot.R, R/utils-proj.R |
Replaced rstudioapi::isAvailable() with is_rstudio() for checking RStudio availability. |
README.md |
Updated content to reflect performance improvements and feature additions across various modules. |
TODO.R |
Added new TODO items for function calls and file titles. |
tests/testthat/_snaps/outline-roxy.md, tests/testthat/test-outline-roxy.R, tests/testthat/_outline/roxy-general2.R |
Added tests and snapshots for Roxygen parsing and outline generation. |
.github/CONTRIBUTING.md |
Updated file path references in contributing guidelines. |
R/outline-roxy.R |
Introduced functions for extracting and joining Roxygen tag sections and interactive document parsing. |
R/rename.R |
Refined file renaming logic, error handling, and regex pattern creation. |
man/outline.Rd |
Added parameters exclude_tests and print_todo to outline functions, with print_todo deprecated. |
tests/testthat/_snaps/outline.md |
Updated output messages and titles for outline elements. |
playground/outline-tree.R |
Added functions to process outline data, generate tree structures, and visualize with cli::tree(). |
tests/testthat/_outline/tree.qmd |
Introduced a test document demonstrating Quarto usage and code execution within the document. |
Sequence Diagram(s) (Beta)
No sequence diagrams are generated for these changes as they are too varied and specific to individual functionalities.
Possibly related issues
- olivroy/reuseme#28: The changes in outline functions and Roxygen parsing directly address feedback and enhancements requested for the
*_outline()functions.
Poem
In RStudio's light, we navigate, With outlines clear, we annotate. Roxygen's whispers now we hear, As files transform, the path is clear. Rename, refine, with joy we tread, In code's embrace, our tasks are led. 🐇✨📜
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?
olivroy
Almost ready? tested on many projects.
Make sure elements are as exclusive as possible..
Slows things down significantly..