posit-dev / posit-dev/great-docs

docments (and perhaps other) parsers

Open
#149 1 comment 1 reaction 1 assignee View on GitHub

@rich-iannone is already working on this.

Since May 6, 2026.

Difficulty: [2] Intermediate Effort: [3] High Priority: [2] Medium Type: ★ Enhancement
Dominant language
Python
Stars
262
Forks
18
Avg merge
1d 4h
Merged PRs (30d)
14

Description

Prework

Proposal

Describe the new feature clearly and concisely. If applicable, write a minimal example in Python or in pseudo-code to show input, usage, and desired output.

It is inevitable that Python documentation guidelines may shift or evolve, and there are already competing documentation standards. One that I particularly enjoyed was fastai's docments, which intervweaves comments and parameters on a line-by-line basis:

def add(
    a:int, # the 1st number to add
    b=0,   # the 2nd number to add
)->int:    # the result of adding `a` to `b`
    "The sum of two numbers."
    return a+b

Their parser is out there and I'm willing to take a stab at it, though I am not nearly as good a Python programmer as I would likely need to be. Just putting this on your radar, and thanks as always for the awesome work!

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.