rust-conventions

Apply Rust coding conventions and math documentation standards to source files.

Updated Feb 6, 2026
One-click install
npx skills add https://github.com/JoernStoehler/msc-math --skill rust-conventions-joernstoehler
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rust-conventions
Source: https://github.com/JoernStoehler/msc-math/tree/main/.claude/skills/rust-conventions
Command: npx skills add https://github.com/JoernStoehler/msc-math --skill rust-conventions-joernstoehler

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Rust conventions and math-documentation standards guide ensures consistent module structure, coordinate conventions, doc comments, and math.tex cross-references across crates/ and experiments/ Rust code, reducing ambiguity and improving maintainability and correctness.

Core Features & Use Cases

  • Module structure guidance for a single crate with clearly delineated modules and submodules (geom, algorithms, kkt, constants, random, dataset).
  • Coordinate and math-code conventions to prevent common mistakes and ensure 1:1 mapping between mathematical concepts and Rust representations.
  • Documentation discipline including doc comments, math.tex references, and frontmatter-driven metadata to support tooling and verification.
  • Use Case: when creating or reviewing Rust code for polytopes, Lagrangian products, and capacity algorithms, apply these conventions to ensure consistency and traceability.

Quick Start

Apply these conventions when editing crates/ and experiments/ Rust code to ensure consistent structure and documentation.

Frequently Asked Questions about rust-conventions

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

FAQPage Schema
How do I enforce 1:1 correspondence between math.tex references and Rust code?

To enforce 1:1 math-code correspondence in Rust, apply coding conventions that map mathematical concepts directly to specific Rust module representations. This reduces ambiguity and ensures traceability between math.tex references and source code.

What is the standard module structure for a Rust crate handling polytopes and capacity algorithms?

Standard Rust module structure for these crates uses clearly delineated submodules like geom, algorithms, kkt, constants, random, and dataset. This organization maintains strict boundaries and consistent frontmatter-driven metadata for tooling.

How do I apply frontmatter-driven metadata for Rust documentation and testing?

Apply frontmatter-driven metadata by embedding standardized metadata fields within Rust source files. This supports automated tooling, verifies math.tex cross-references, and enforces documentation discipline across crates and experiments.

Does this Rust convention guide work for reviewing Lagrangian product implementations?

Yes, these Rust coding conventions are designed for creating and reviewing code involving polytopes, Lagrangian products, and capacity algorithms. They ensure coordinate conventions and math-code mappings remain consistent during code reviews.

When do I need strict coding conventions for Rust crates with math.tex cross-references?

You need strict Rust coding conventions when writing, editing, or reviewing modules that rely on math.tex cross-references. Applying these standards prevents common coordinate convention mistakes and improves maintainability for mathematical source files.