Skip to content

Commit cb6fc6e

Browse files
docs work
1 parent 9d5116e commit cb6fc6e

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

Diff for: templates/template.doc.constructor

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
"""
2+
julia> res = % method name and typeless arguments
3+
4+
% Description
5+
6+
# Signature
7+
8+
% full function signature
9+
10+
# Arguments
11+
12+
- % argument list -> `arg`: meaning
13+
- optional
14+
- `name`: custom name
15+
- `DDT`: domain data type
16+
- `RDT`: range data type
17+
- % argument list -> `arg`: meaning
18+
19+
# Notes
20+
21+
- % extra information
22+
23+
# Examples
24+
25+
% description
26+
27+
% example
28+
29+
"""

Diff for: templates/template.doc.function

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
julia> op = % method name and typeless arguments
2+
julia> res = % method name and typeless arguments
33

44
% Description including return type
55

@@ -15,4 +15,14 @@
1515
- keyword
1616
- % argument list -> `arg`: meaning, defaults to ???
1717

18+
# Notes
19+
20+
- % extra information
21+
22+
# Examples
23+
24+
% description
25+
26+
% example
27+
1828
"""

0 commit comments

Comments
 (0)