NeuroTechX / NeuroTechX/moabb

The docs is working as test sometimes

Open
#595 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation moabb
Dominant language
Python
Stars
1.1k
Forks
264
Avg merge
1d 13m
Merged PRs (30d)
23

Description

At the moment, the generation of the docs is working as a "test." This behavior is not desired and reveals a lack of testing. We need to solve this.

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.

Research direction

Start by locating the documentation-generation entry point and the tests around it. Clarify how documentation generation is currently acting as a test, then add or adjust dedicated testing so documentation generation no longer serves that role.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.