Re-Add Function Documentation #320
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johannes-wolf
force-pushed
the
readd-function-documentation
branch
4 times, most recently
from
0443cb9
to
f27d5d3
Compare
johannes-wolf
force-pushed
the
hobby-curve
branch
from
87f3274
to
451ee37
Compare
johannes-wolf
force-pushed
the
readd-function-documentation
branch
from
f27d5d3
to
b6d8ad5
Compare
johannes-wolf
force-pushed
the
hobby-curve
branch
5 times, most recently
from
784e61f
to
6a4d6f9
Compare
johannes-wolf
force-pushed
the
readd-function-documentation
branch
from
b6d8ad5
to
55bf131
Compare
johannes-wolf
force-pushed
the
hobby-curve
branch
from
6a4d6f9
to
e9d4167
Compare
johannes-wolf
force-pushed
the
hobby-curve
branch
from
e9d4167
to
9234760
Compare
johannes-wolf
force-pushed
the
readd-function-documentation
branch
2 times, most recently
from
51914a0
to
ba494da
Compare
|
Rebased. |
fenjalien
force-pushed
the
readd-function-documentation
branch
2 times, most recently
from
0b0ae70
to
1f6aa2c
Compare
Merged
johannes-wolf
force-pushed
the
readd-function-documentation
branch
5 times, most recently
from
5141069
to
0a360e7
Compare
johannes-wolf
force-pushed
the
readd-function-documentation
branch
from
f0acced
to
bee9610
Compare
Merged
manual.pdf
Outdated
There was a problem hiding this comment.
Palettes are not showing the entire palette like before. I liked the version on the left side more. Is this intended?
There was a problem hiding this comment.
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.
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 | |||
JohnMeyerhoff
suggested changes
Dec 1, 2023
johannes-wolf
force-pushed
the
readd-function-documentation
branch
from
8335ca4
to
44a6a00
Compare
fenjalien
approved these changes
Dec 3, 2023
| @@ -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.
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.
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.
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.
Typo: "an dictionary" should be "a dictionary"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.