docs: add shabnam to developer notes #12
Conversation
|
""" WalkthroughThis update adds a new radiomics feature extraction configuration YAML file, introduces detailed developer notes for two contributors, and restructures the documentation navigation to separate these notes. It includes new documentation files, an updated navigation configuration, and a new radiomics extraction settings file. Changes
Possibly related PRs
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
config/pyradiomics/aerts_original_wavelet.yaml (1)
15-15: Add a newline at end-of-file.
YAML files should end with a single newline to satisfy linter rules and avoid warnings.🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 15-15: no new line character at the end of file
(new-line-at-end-of-file)
docs/devnotes/shabnam_notes.md (2)
6-6: Use consistent heading levels.
You're jumping from an H1 (# Developer Notes) directly to an H4 (#### [2025-05-20] ...). Use H2 or H3 for this subsection:- #### [2025-05-20] Tracking extraction of all features for Aerts signature + ## [2025-05-20] Tracking extraction of all features for Aerts signature🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
6-6: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4(MD001, heading-increment)
17-17: Add a comma for readability.
Insert a comma after "config file" to improve sentence flow:- I think the paths in the run readii should be passed in a config file since I can't run two datasets at the same time. + I think the paths in the run readii should be passed in a config file, since I can't run two datasets at the same time.🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...run readii should be passed in a config file since I can't run two datasets at the s...(AI_HYDRA_LEO_MISSING_COMMA)
docs/devnotes/katy_notes.md (5)
4-4: Normalize heading increments.
You have an H1 (# Developer Notes) followed by an H4 (#### [2025-05-05] ...). Use H2 or H3 for these date-stamped sections:- #### [2025-05-05] PyRadiomics original_all_features extraction tracking + ## [2025-05-05] PyRadiomics original_all_features extraction tracking🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
4-4: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
28-28: Convert bare URL to a Markdown link.
Replace the plain URL with a hyperlink to conform to lint rules:- * Bootstrapping help came from: https://acclab.github.io/bootstrap-confidence-intervals.html + * Bootstrapping help came from: [Bootstrap Confidence Intervals](https://acclab.github.io/bootstrap-confidence-intervals.html)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
28-28: Bare URL used
null(MD034, no-bare-urls)
35-36: Fix nested list indentation.
Nested items under "Since RADCURE was processed..." should be indented by two spaces, not four:- * Change the column `patient_ID` to `PatientID` - * Add index column label `SampleID` + * Change the column `patient_ID` to `PatientID` + * Add index column label `SampleID`🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
35-35: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
49-49: Adjust heading level for manuscript feedback section.
Under "## Manuscript Notes", the date-stamped section should be H3, not H4:- #### [2025-05-14] Manuscript Review Feedback Notes + ### [2025-05-14] Manuscript Review Feedback Notes🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
51-51: Replace emphasized section titles with proper headings.
Use Markdown headings instead of bold text for section names:- **Introduction/Background** + ### Introduction/Background - **Methods** + ### Methods - **Results** + ### Results - *Plots* + ### PlotsAlso applies to: 56-56, 67-67, 81-81
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
config/pyradiomics/aerts_original_wavelet.yaml(1 hunks)docs/devnotes/.pages(1 hunks)docs/devnotes/katy_notes.md(1 hunks)docs/devnotes/shabnam_notes.md(1 hunks)mkdocs.yaml(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/devnotes/katy_notes.md
4-4: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
28-28: Bare URL used
null
(MD034, no-bare-urls)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
49-49: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
51-51: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
53-53: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
54-54: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
56-56: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
58-58: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
60-60: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
63-63: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
64-64: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
67-67: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
75-75: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
76-76: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
77-77: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
78-78: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
79-79: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
81-81: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
83-83: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
88-88: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/devnotes/shabnam_notes.md
6-6: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
🪛 LanguageTool
docs/devnotes/shabnam_notes.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...run readii should be passed in a config file since I can't run two datasets at the s...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 YAMLlint (1.37.1)
config/pyradiomics/aerts_original_wavelet.yaml
[error] 15-15: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (1)
docs/devnotes/.pages (1)
1-3: Navigation entries look correct.
The order and filenames correspond to the newly added developer notes files.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit