Add information about the file causing the error
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
When getting error messages it does not provide information about the file causing the error
compilando [html]: todos los archivos fuente
actualizando ambiente: [nueva configuración] 12añadido, 0 cambiado, 0 removido
:4: (SEVERE/4) Unexpected section title.
Parameters
----------
WARNING: [numpydoc] Validation warnings while processing docstring for 'foo.Bar':
SS03: Summary does not end with a period
ES01: No extended summary found
PR01: Parameters {'this', 'that', 'here'} not documented
SA01: See Also section not found
EX01: No examples section found
[...]
error en marcado de reST:
:4: (SEVERE/4) Unexpected section title.
Parameters
----------
I would expect to have some information about the file/function/class/method causing the error.
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 reproducing the shown numpydoc validation and reST errors, then trace how those messages are reported. Determine where source file, function, class, or method context could be attached without losing the existing diagnostics. Done means the reported error identifies the relevant source context; the issue names no files or tests to run.
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
- 35/100