numpy / numpy/numpydoc

Allow multiple `Warning(s)` sections

Open
#594 11 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

Using the specified Warnings section I can get something that looks like this:

image

It would be nice to be able to split this into two separate admonitions. It feels natural to me to have two separate headers, both titled Warning.

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

The issue names no files or tests. Begin by locating the existing handling for the Warnings section, then determine how repeated Warning headers are parsed and rendered; done means two separate Warning admonitions are supported while the existing single-section behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.