numpy / numpy/numpydoc

Proposal to create Markdown equivalent of specification

Open
#692 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Markdown is, by now, much more commonly used than ReST, and so I wonder if the time hasn't come for us to provide a markdown equivalent to the numpydoc format?

I've taken a first stab at it, and would love to hear what you think:

https://hackmd.io/_EKGyNRbQ2Sx_UJVqur2CA

In the end, the changes were fairly minimal, and can mostly be made with an automated tool.

Questions:

  • Is this worth doing?
  • If so:
    • Which header syntax to use? (I think the current underline syntax—valid markdown—works better than ##)
    • Are the custom introduced roles OK? ({param}, {func}, {class}, {obj}, etc.)
    • How do we signal to documentation engines which version we are using?

Improvements:

  • I think turning single-backticks into an explicit {param}`x` solves a long confusing aspect: when to use single vs double backticks (the prior is for linking to parameters, the latter is for code, FWIW).

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

Start by reading the linked HackMD proposal alongside the current numpydoc specification and its ReST conventions. Evaluate the proposed header syntax, custom roles, and version signaling, then determine whether the format is accepted and what documentation-engine changes would be required. Done means an agreed specification and implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.