dhruvasagar/vim-table-mode

Support tables in source code comments

Open

#241 opened on Jan 22, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Vim Script (98 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (2,236 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Please support creating tables within source code comments written with Markdown.

For example:

/// | parameter | description                   |
/// |-----------|-------------------------------|
/// | `n`       | number of players             |
/// | `start`   | starting score of each player |
/// | `k`       | scaling factor                |

Contributor guide

Research direction
Study the existing table creation and formatting logic, then extend it to detect and format Markdown tables inside source code comments.
Tech stack
None
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70