Possible improvements to structuring of Decoding (MVPA) documentation

Open
#13,707 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Tech stack
python
Domain
documentation, machine-learning

Research direction

The issue does not name a documentation file, test, or entry point. First locate the Decoding (MVPA) documentation, review how conceptual explanations and equations are currently arranged, and confirm the intended structure with maintainers; done means the approved concepts and equations are separated into clearer sections.

Written by the indexing model from the issue text.

Description

DOC
Proposed documentation enhancement

While going through the Decoding(MVPA) documentation, I felt there may be room for improving the structure for better clarity.
currently, conceptual explanations and equations are embedded within paragraphs. It might be clearer to separate key concepts and equations into distinct sections for improved readability and understanding.

I wanted to take input from maintainers on whether this would be a useful improvement before proposing any changes.
Thanks!

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mne-tools/mne-python

All issues in mne-tools/mne-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.