Skip to content

Thorough Documentation Update for Thrive Project#1

Closed
google-labs-jules[bot] wants to merge 1 commit into
devfrom
documentation-update-6963669931330741290
Closed

Thorough Documentation Update for Thrive Project#1
google-labs-jules[bot] wants to merge 1 commit into
devfrom
documentation-update-6963669931330741290

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

@google-labs-jules google-labs-jules Bot commented Jan 19, 2026

This PR comprehensively documents the entire repository, which was previously lacking in comments and documentation. It targets a mixed-language codebase (Python, R, MATLAB, C++) used for the thrive-theta-ddm project (EEG analysis and SSP-DDM modeling).

Changes:

  1. Python: Applied Google Style docstrings to all scripts and functions. Added file-level docstrings explaining script usage.
  2. R: Applied Roxygen2 style documentation (#') to functions and scripts.
  3. C++: Applied Doxygen style documentation (/** ... */) to the DDM simulation code.
  4. MATLAB: Applied standard MATLAB help comments (%) at the top of functions and scripts.
  5. README: Completely rewrote the root README.md (replacing a template) to describe the project goals, scientific background, directory structure, and analysis workflow. Updated code/readme.md as well.

Verification:

  • Verified that all source files in code/ subdirectories were processed.
  • Checked syntax of added comments to ensure no code logic was altered.
  • Code review confirmed correctness and completeness.

PR created automatically by Jules for task 6963669931330741290 started by @fzakirov

- Added Google Style docstrings to all Python files in `code/behavior`, `code/ddm`, `code/preprocessing-eeg`, `code/postprocessing`, and `code/figures`.
- Added Roxygen2 style comments to R files in `code/ddm` and `code/statistics`.
- Added Doxygen style comments to C++ file `code/ddm/simSSP_model_GB_noScale.cpp`.
- Added standard MATLAB help comments to all .m files in `code/matlab`, `code/figures`, and `code/preprocessing-eeg`.
- Rewrote root `README.md` to provide project overview, structure, and usage instructions.
- Updated `code/readme.md`.
- Ensured all scripts and functions have file-level and function-level documentation explaining purpose, inputs, and outputs.
@google-labs-jules
Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@fzakirov fzakirov closed this Feb 13, 2026
@fzakirov fzakirov deleted the documentation-update-6963669931330741290 branch February 13, 2026 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant