skills.rest
planetis-m
planetis-mCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

nim-doc-comments

Write Nim documentation comments and verify rendered output with nim doc.

Updated Aug 23, 2026
Search Tags:#documentation#doc comments#public api#nim#nim doc#source layout
One-click install
npx skills add https://github.com/planetis-m/skills_experiment --skill nim-doc-comments
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: nim-doc-comments
Source: https://github.com/planetis-m/skills_experiment/tree/main/original_skills/nim-doc-comments
Command: npx skills add https://github.com/planetis-m/skills_experiment --skill nim-doc-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps you add high-quality Nim documentation comments that render properly in generated docs, reducing confusion for users of your public APIs.

Core Features & Use Cases

  • Correct doc placement in standard Nim source layout for modules, procedures, iterators, templates, converters, and types.
  • Consistent documentation style that summarizes behavior, usage, constraints, and error/sider-effect expectations.
  • Verification with nim doc so the rendered output matches your intent and stays readable.

Quick Start

Use the nim-doc-comments skill to write and verify module and exported symbol doc comments for the affected Nim files in your project.

Frequently Asked Questions about nim-doc-comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write Nim doc comments that render correctly with nim doc?▼

To ensure Nim doc comments render correctly, place them in the standard source layout for exported procs, types, and modules, then verify the generated output by running nim doc on the target module.

What is the correct placement for Nim documentation comments on public APIs?▼

Correct Nim documentation comment placement requires positioning them in the standard source layout for modules, procedures, iterators, templates, converters, and types to ensure they attach to exported public API symbols.

Why does my nim doc output not show comments for exported procs?▼

Nim doc output fails to show comments when documentation placement does not satisfy standard source layout requirements for exported procs, requiring verification by running nim doc on the affected module to check the rendered output.

How do I verify my Nim module documentation renders correctly?▼

You verify Nim module documentation renders correctly by running nim doc on the target module, ensuring the generated output matches your intent and stays readable for public API consumers.

What should Nim documentation comments include for a consistent style?▼

Consistent Nim documentation comments should summarize behavior, usage, constraints, and error or side-effect expectations for exported procs, types, and constants to reduce confusion for public API users.

Can I use this approach to add inline docs when refactoring Nim modules?▼

Yes, you can apply this approach when refactoring Nim modules or adding module overviews to produce correct inline docs and verify their rendered output for exported public APIs.

Related Skills

Explore More Software Engineering Skills→
mattbobambrosemattbobambrose
1

add-docs

Add inline documentation comments to undocumented public symbols in source files across a repository.

Community
Intermediate
planetis-mplanetis-m
54

update-api-docs

Generate markdown API documentation for Nim source files using jsondoc.

Community
Intermediate
AbeJitsuAbeJitsu

format-standardize

Apply user-defined formatting standards across code, documentation, and content outputs using ESLint and Prettier.

Community
Basic
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate