Doc generation failure
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 139
- Forks
- 52
- Avg merge
- 1h 16m
- Merged PRs (30d)
- 3
Description
I'm trying to build the documentation, which causes a TypeError in the doc_gen.py file.
Build details:
OS: Windows 10 Enterprise
pip: 23.0.1
Python: 3.10.11
The issue is that DirectorOutputDto constructor is missing a required positional argument: 'ssa_detections'
The fix is that line 16 in doc_gen.py needs to go from DirectorOutputDto([],[],[],[],[],[],[],[]) to DirectorOutputDto([],[],[],[],[],[],[],[],[])
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation build and inspect line 16 of doc_gen.py, where the DirectorOutputDto constructor is called. Confirm the constructor arguments against its definition, then rerun the documentation build on the reported Python environment. Done means the build completes without the reported TypeError.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100