Documentation has two or three spaces seemingly randomly inserted in the middle
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Noticed that there are extra spaces in seemingly random locations in the documentation.
For example, nifgen.AnalogPath.FIXED_LOW_GAIN in its docstring:
Specifies use of the low-gain amplifier in the main path, no matter what value the user specifies for gain. This setting limits the output range.
The problem probably comes from extracted metadata, and it's not clear how or where to fix this. Also, when RST is rendered to HTML, it's masked so the problem really is only visible for docstrings.
Contributor guide
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 by tracing how extracted metadata produces the nifgen.AnalogPath.FIXED_LOW_GAIN docstring; the issue does not name a source file, test, or entry point. Compare generated docstrings with the source metadata and determine where the extra spaces are introduced. Done means docstrings no longer contain the unwanted repeated spaces, while rendered RST-to-HTML output remains correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100