numpy / numpy/numpydoc

ValueError: The section Notes appears twice in the docstring of None in None.

Open
#152 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
355
Forks
181
Avg merge
1d 9h
Merged PRs (30d)
3

Description

I have been trying this sphinx extension for the first time today, and I keep hitting this error. I can't find anywhere where this is the case, so I can't fix it.

Can you please help?

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

No file, test, or entry point is named. Start by reproducing the reported ValueError while using the Sphinx extension, then trace how the duplicated Notes section and the None values are detected; done when the cause is identified and the extension reports or handles the affected docstring correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.