-
-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Re-Add Function Documentation #320
Conversation
0443cb9
to
f27d5d3
Compare
87f3274
to
451ee37
Compare
f27d5d3
to
b6d8ad5
Compare
784e61f
to
6a4d6f9
Compare
b6d8ad5
to
55bf131
Compare
6a4d6f9
to
e9d4167
Compare
e9d4167
to
9234760
Compare
51914a0
to
ba494da
Compare
Rebased. |
0b0ae70
to
1f6aa2c
Compare
5141069
to
0a360e7
Compare
f0acced
to
bee9610
Compare
manual.pdf
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The palette fix PR #332 should fix that.
@@ -174,6 +244,14 @@ | |||
},) | |||
} | |||
|
|||
/// TODO: Not writing the docs for this as it should be removed in place of better anchors before 0.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this ToDo resolved?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No not yet I should have time this week to reslove it though.
@@ -261,6 +408,16 @@ | |||
},) | |||
} | |||
|
|||
/// TODO: Not writing the docs for this as it should be removed in place of better anchors before 0.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this also resolved?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me except for some wordings / typos :)
8335ca4
to
44a6a00
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found some more typos in matrix.typ
, the rest looks good to me 👍
@@ -8,7 +8,13 @@ | |||
|
|||
#let pi = calc.pi | |||
|
|||
// Create identity matrix with dim `m`, `n` | |||
/// Create identity matrix with dimensions $m times n$ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording:
dimensions m times n should be
dimensions m by n
#let dim(m) = { | ||
return (m.len(), if m.len() > 0 {m.at(0).len()} else {0}) | ||
} | ||
|
||
// Return 4x4 translation matrix | ||
/// Return a $4 times 4$ translation matrix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above:
4 by 4 translation matrix
#let transform-translate(x, y, z) = { | ||
((1, 0, 0, x), | ||
(0, 1, 0, y), | ||
(0, 0, 1, z), | ||
(0, 0, 0, 1)) | ||
} | ||
|
||
// Return 4x4 z-shear matrix | ||
/// Return a $4 times 4$ z-shear matrix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above:
4 by 4 translation matrix
@@ -847,7 +847,7 @@ get-ctx(ctx => { | |||
|
|||
Each CeTZ element (`line`, `bezier`, `circle`, ...) returns an array of | |||
functions for drawing to the canvas. Such function takes the canvas' | |||
context object and must return an dictionary of the following keys: | |||
context and must return an dictionary of the following keys: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "an dictionary" should be "a dictionary"
This PR re-adds source-code documentation comments:
Also added some additional information.
Documentation about path internals and how to modify paths to create path effects has not yet been added.