julia-docstrings
CommunityWrite clear Julia docstrings.
AuthorKrastanov
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps you write clear, consistent, and informative documentation for your Julia code, making it easier for others (and your future self) to understand and use.
Core Features & Use Cases
- Standardized Documentation: Follows SciML conventions for documenting functions, types, and modules.
- DocStringExtensions.jl Integration: Leverages macros like
$TYPEDEF,$TYPEDFIELDS, and$TYPEDSIGNATURESfor concise and structured docstrings. - Use Case: When you've just finished writing a new Julia function, use this skill to generate a well-formatted docstring that explains its purpose, arguments, return values, and includes examples.
Quick Start
Use the julia-docstrings skill to write a docstring for the following function signature: function my_function(x::Int, y::String)
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: julia-docstrings Download link: https://github.com/Krastanov/JuliaLLMAgentSkills/archive/main.zip#julia-docstrings Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.