Reference GitHub issues in TODO comments for better traceability #10
Conversation
fpahlke
commented
Nov 26, 2025
fpahlke
commented
- Link TODOs to relevant GitHub issues in multiple R files
- Update comments for block size randomizer and method classes
- Add issue references for factorLevels and strataIds TODOs
- Link TODOs to relevant GitHub issues in multiple R files - Update comments for block size randomizer and method classes - Add issue references for factorLevels and strataIds TODOs
There was a problem hiding this comment.
Pull request overview
This PR improves code maintainability by linking TODO comments to their corresponding GitHub issues for better traceability. All TODO comments now include full GitHub issue URLs, making it easier to track the context and status of pending implementations.
Key changes:
- Added GitHub issue references to existing TODO comments across 5 R files
- Simplified a multi-line TODO comment about logging to a concise single-line format
- Relocated a TODO comment from function signature to function body for better clarity
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| R/f_random_service.R | Added issue #4 references to strataIds and factorLevels implementation TODOs |
| R/class_random_system_state.R | Added issue #8 reference to TODO about incrementing factor and strata levels |
| R/class_random_method_range_set.R | Added issue #9 reference to TODO about sorting randomMethodRanges |
| R/class_random_method_pbr.R | Simplified and added issue #6 reference to logging TODO |
| R/class_random_block_size_randomizer.R | Moved TODO from function signature to body and added issue #7 reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| .self$values <- sample.int(n = numberOfBlockSizes, size = numberOfValuesToCreate, replace = TRUE) | ||
| }, | ||
| nextInt = function(numberOfBlockSizes) { # TODO implement numberOfBlockSizes | ||
| nextInt = function(numberOfBlockSizes) { |
There was a problem hiding this comment.
The removal of the inline TODO comment from the function signature improves readability, but the function parameter numberOfBlockSizes is not actually used in the function body (only the pre-initialized values are used). Consider adding a comment in the function documentation explaining that this parameter is not yet implemented but is reserved for issue #7.
